Skip to content

docs: Add a development guide #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Development

Quickstart for functions-framework maintainers.

## Environment setup

Install [tox](https://pypi.org/p/tox), the test runner:

```
$ python -m pip install -U tox
```

## Running linting

Linting can be run with:

```
$ python -m tox -e lint
```

## Running tests

All tests can be run with:

```
$ python -m tox
```

Tests for the current Python version can be run with:

```
$ python -m tox -e py
```

Tests for a specific Python version can be run with:

```
$ python -m tox -e py3.12
```

A specific test file (e.g. `tests/test_cli.py`) can be run with:

```
$ python -m tox -e py -- tests/test_cli.py
```

A specific test in the file (e.g. `test_cli_no_arguements` in `tests/test_cli.py`) can be run with:

```
$ python -m tox -e py -- tests/test_cli.py::test_cli_no_arguments
```

## Releasing

Releases are triggered via the [Release Please](https://github.com/apps/release-please) app, which in turn kicks off the [Release to PyPI](https://github.com/GoogleCloudPlatform/functions-framework-python/blob/main/.github/workflows/release.yml) workflow.
Loading