Coming soon
- django-basin3d uses the GitFlow model of branching and code versioning in git.
- Code development will be performed in a forked copy of the repo. Commits will not be made directly to the django-basin3d repo. Developers will submit a pull request that is then merged by another team member, if another team member is available.
- Each pull request should contain only related modifications to a feature or bug fix.
- Sensitive information (secret keys, usernames etc) and configuration data (e.g database host port) should not be checked in to the repo.
- A practice of rebasing with the main repo should be used rather that merge commmits.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
$ git clone [email protected]:BASIN-3D/django-basin3d.git
$ cd django-basin3d
Setup virtualenv for development and testing purposes. All django-basin3d tests
are in example-django.
See Example Django Project section on README.md for example project.
Sphinx is used to generate documentation.
You first need to create a virtual environment for generating the docs and install docs requirements.
$ pip install -e ".[docs]"
Generate the documentation
$ cd docs
$ make html
Review the generated documentation
$ open _build/html/index.html
We use SemVer for versioning. For the versions available, see the tags on this repository.
Workflow for tagging and building release:
- checkout the version to tag from
master git tag -a v[version]-[release] -m "Tagging release v[version]-[release]"- build distribution with
setup.py git push origin v[version]-[release]