All contributions to databases are welcome!
To make it as simple as possible for us to help you, please include the following:
- python version
- databases version
- database backend (mysql, sqlite or postgresql)
- database driver (aiopg, aiomysql etc.)
Please try to always include the above unless you're unable to install databases or know it's not relevant to your question or feature request.
It should be quite straight forward to get started and create a Pull Request.
Unless your change is trivial (typo, docs tweak etc.), please create an issue to discuss the change before creating a pull request.
To make contributing as easy and fast as possible, you'll want to run tests and linting locally.
You'll need to have python >= 3.6 (recommended 3.7+) and git installed.
Clone your fork and cd into the repo directory
git clone firstname.lastname@example.org:<your username>/databases.git cd databases
Create and activate virtual env
virtualenv env source env/bin/activate
Install databases, dependencies and test dependencies
pip install -r requirements.txt
Checkout a new branch and make your changes
git checkout -b my-new-feature-branch
Make your changes...
Formatting and linting - databases uses black for formatting, autoflake for linting and mypy for type hints check run all of those with lint script
Prepare tests (basic)
TEST_DATABASE_URLSenv variable where you can comma separate urls for several backends
The simples one is for sqlite alone:
Prepare tests (all backends)
- In order to run all backends you need either a docker installation on your system or all supported backends servers installed on your local machine.
- A sample docker configuration that reflects the CI/CD workflow of databases might be:
version: '2.1' services: postgres: image: postgres:10.8 environment: POSTGRES_USER: username POSTGRES_PASSWORD: password POSTGRES_DB: testsuite ports: - 5432:5432 mysql: image: mysql:5.7 environment: MYSQL_USER: username MYSQL_PASSWORD: password MYSQL_ROOT_PASSWORD: password MYSQL_DATABASE: testsuite ports: - 3306:3306
sqlite:///test.db, sqlite+aiosqlite:///test.db, mysql+aiomysql://username:password@localhost:3306/testsuite, mysql+asyncmy://username:password@localhost:3306/testsuite, postgresql+aiopg://username:email@example.com:5432/testsuite, postgresql+asyncpg://username:password@localhost:5432/testsuite
If you have changed the documentation make sure it runs successfully. You can preview the live documentation by running the following command:
Commit, push, and create your pull request