This project was created using temple. For more information about temple, go to the Temple docs.
Set up your development environment with:
git clone email@example.com:CloverHealth/temporal-sqlalchemy.git cd temporal-sqlalchemy make setup
make setup will setup a virtual environment managed by pyenv and install dependencies.
Note that if you’d like to use something else to manage dependencies other than pyenv, call
make dependencies instead of
Testing and Validation¶
Run the tests with:
Validate the code with:
Sphinx documentation can be built with:
The static HTML files are stored in the
docs/_build/html directory. A shortcut for opening them is:
Releases and Versioning¶
Anything that is merged into the master branch will be automatically deployed to PyPI. Documentation will be published to ReadTheDocs.
The following files will be generated and should not be edited by a user:
ChangeLog- Contains the commit messages of the releases. Please have readable commit messages in the master branch and squash and merge commits when necessary.
AUTHORS- Contains the contributing authors.
version.py- Automatically updated to include the version string.
sem-ver: feature, Added this functionality that does blah.
Depending on the sem-ver tag, the version will be bumped in the right way when releasing the package. For more information, about PBR, go the the PBR docs.