We welcome contributions to python-sentry by the community. See the Contributing to Docs page if you want to fix or update the documentation on the website.

Please search the issue tracker before creating a new issue (a problem or an improvement request). Please also ask in our Sentry Community on Discord before submitting a new issue. There is a ton of great people in our Discord community ready to help you!

If you feel that you can fix or implement it yourself, please read a few paragraphs below to learn how to submit your changes.

• Setup the development environment.
• Clone sentry-python and prepare necessary changes.
• Add tests for your changes to tests/.
• Run tests and make sure all of them pass.
• Submit a pull request, referencing any issues it addresses.

We will review your pull request as soon as possible. Thank you for contributing!

git clone git@github.com:getsentry/sentry-python.git

Make sure that you have Python 3 installed. Version 3.7 or higher is required to run style checkers on pre-commit. On macOS, we recommend using brew to install Python. For Windows, we recommend an official python.org release.

cd sentry-python

python -m venv .env

source .env/bin/activate

pip install -e .

Hint: Sometimes you need a sample project to run your new changes to sentry-python. In this case install the sample project in the same virtualenv and you should be good to go because the pip install -e . from above installed your local sentry-python in editable mode. So you can just hack away!

cd sentry-python

pip install -r linter-requirements.txt

pip install pre-commit

pre-commit install

That's it. You should be ready to make changes, run tests, and make commits! If you experience any problems, please don't hesitate to ping us in our Discord Community.

We have a Makefile to help people get started with hacking on the SDK without having to know or understand the Python ecosystem. Run make or make help to list commands.

So the simplest way to run tests is:

cd sentry-python

make tests

This will use Tox to run our whole test suite under Python 2.7 and Python 3.7.

Of course you can always run the underlying commands yourself, which is particularly useful when wanting to provide arguments to pytest to run specific tests:

cd sentry-python

# create virtual environment
python -m venv .env

# activate virtual environment
source .env/bin/activate

# install sentry-python
pip install -e .

# install requirements
pip install -r test-requirements.txt

# run tests
pytest tests/

If you want to run the tests for a specific integration you should do so by doing this:

pytest -rs tests/integrations/flask/

Hint: Tests of integrations need additional dependencies. The switch -rs will show you why tests where skipped and what dependencies you need to install for the tests to run. (You can also consult the tox.ini file to see what dependencies are installed for each integration)

We use craft to release new versions. You need credentials for the getsentry PyPI user, and must have twine installed globally.

The usual release process goes like this:

1. Go through git log and write new entry into CHANGELOG.md, commit to master
2. craft p a.b.c
3. craft pp a.b.c

1. Write the integration.

   • Instrument all application instances by default. Prefer global signals/patches instead of configuring a specific instance. Don't make the user pass anything to your integration for anything to work. Aim for zero configuration.

   • Everybody monkeypatches. That means:

     • Make sure to think about conflicts with other monkeypatches when monkeypatching.

     • You don't need to feel bad about it.

   • Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.

   • Allow the user to disable the integration by changing the client. Check Hub.current.get_integration(MyIntegration) from within your signal handlers to see if your integration is still active before you do anything impactful (such as sending an event).

2. Write tests.

   • Think about the minimum versions supported, and test each version in a separate env in tox.ini.

   • Create a new folder in tests/integrations/, with an __init__ file that skips the entire suite if the package is not installed.

3. Update package metadata.

   • We use extras_require in setup.py to communicate minimum version requirements for integrations. People can use this in combination with tools like Poetry or Pipenv to detect conflicts between our supported versions and their used versions programmatically.

     Do not set upper-bounds on version requirements as people are often faster in adopting new versions of a web framework than we are in adding them to the test matrix or our package metadata.

4. Write the docs. Answer the following questions:

   • What does your integration do? Split in two sections: Executive summary at top and exact behavior further down.

   • Which version of the SDK supports which versions of the modules it hooks into?

   • One code example with basic setup.

   • Make sure to add integration page to python/index.md (people forget to do that all the time).

Tip: Put most relevant parts wrapped in <!--WIZARD-->..<!--ENDWIZARD--> tags for usage from within the Sentry UI.

5. Merge docs after new version has been released (auto-deploys on merge).

6. (optional) Update data in sdk_updates.py to give users in-app suggestions to use your integration. May not be applicable or doable for all kinds of integrations.

See the documentation on commit messages here:

https://develop.sentry.dev/commit-messages/#commit-message-format