Contributing to APScheduler

If you wish to contribute a fix or feature to APScheduler, please follow the following guidelines.

When you make a pull request against the main APScheduler codebase, Github runs the test suite against your modified code. Before making a pull request, you should ensure that the modified code passes tests and code quality checks locally.

Running the test suite

The test suite has dependencies on several external services, such as database servers. To make this easy for the developer, a docker-compose configuration is provided. You need both Docker (or a suitable replacement) and docker-compose installed to start them. Once you do, you can start the services with this command:

docker-compose up -d

You can run the test suite two ways: either with tox, or by running pytest directly.

To run tox against all supported (of those present on your system) Python versions:

tox

Tox will handle the installation of dependencies in separate virtual environments.

To pass arguments to the underlying pytest command, you can add them after --, like this:

tox -- -k somekeyword

To use pytest directly, you can set up a virtual environment and install the project in development mode along with its test dependencies (virtualenv activation demonstrated for Linux and macOS; on Windows you need venv\Scripts\activate instead):

python -m venv venv
source venv/bin/activate
pip install -e .[test]

Now you can just run pytest:

pytest

Building the documentation

To build the documentation, run tox -e docs. This will place the documentation in build/sphinx/html where you can open index.html to view the formatted documentation.

APScheduler uses ReadTheDocs to automatically build the documentation so the above procedure is only necessary if you are modifying the documentation and wish to check the results before committing.

APScheduler uses pre-commit to perform several code style/quality checks. It is recommended to activate pre-commit on your local clone of the repository (using pre-commit install) to ensure that your changes will pass the same checks on GitHub.

Making a pull request on Github

To get your changes merged to the main codebase, you need a Github account.

  1. Fork the repository (if you don’t have your own fork of it yet) by navigating to the main APScheduler repository and clicking on “Fork” near the top right corner.

  2. Clone the forked repository to your local machine with git clone git@github.com/yourusername/apscheduler.

  3. Create a branch for your pull request, like git checkout -b myfixname

  4. Make the desired changes to the code base.

  5. Commit your changes locally. If your changes close an existing issue, add the text Fixes #XXX. or Closes #XXX. to the commit message (where XXX is the issue number).

  6. Push the changeset(s) to your forked repository (git push)

  7. Navigate to Pull requests page on the original repository (not your fork) and click “New pull request”

  8. Click on the text “compare across forks”.

  9. Select your own fork as the head repository and then select the correct branch name.

  10. Click on “Create pull request”.

If you have trouble, consult the pull request making guide on opensource.com.