Contents¶
tidytern¶
| docs | |
|---|---|
| tests |    |
| package |      |
Disciplined versioned schema migration of PostgreSQL databases
Installation¶
pip install tidytern
You can also install the in-development version with:
pip install https://github.com/agravier/tidytern/archive/master.zip
Documentation¶
Development¶
Python versions (both for development and for tox tests) and are most easily managed with Pyenv and its virtualenv plugin.
To install the latest supported Python versions with pyenv and list them in the local .python-version file for use by tox:
pyenv install 3.7.4 && pyenv install 3.8.0b4
Running tests¶
The test runner is pytest. The tool used to automate running various types
of tests under different environments is tox.
Install tox in the global Python 3 environment. It may be installed using your package manager or with pip:
pip3 install tox
To run the all tests, ensure that you are not within a virtualenv and run:
tox
To combine the coverage data from all the tox environments run:
| Windows | set PYTEST_ADDOPTS=--cov-append
tox
|
|---|---|
| Other | PYTEST_ADDOPTS=--cov-append tox
|
Two requirements files are used to describe the development setup:
- The requirements.txt file describes a working development environment with all pinned dependencies.
- The requirements-base.txt file contains the direct unpinned dependencies only.
TODOs¶
- Change ‘3.8-dev’ to ‘3.8’ once the final release of Python 3.8 has landed
Credits¶
The initial project was setup with the help of ionelmc’s cookiecutter template.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Documentation improvements¶
tidytern could always use more documentation, whether as part of the official tidytern docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/agravier/tidytern/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up tidytern for local development:
Fork tidytern (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:agravier/tidytern.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
toxCommit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
tox) [1]. - Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rstabout the changes. - Add yourself to
AUTHORS.rst.
| [1] | If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though … |
Tips¶
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel (you need to pip install detox):
detox
Authors¶
- Alexandre Gravier - http://agravier.com