Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.51 KB

CONTRIBUTING.rst

File metadata and controls

61 lines (39 loc) · 1.51 KB

Development setup

You can set up the project and install development dependencies via:

pip install -e .[test]

You can also run the CI locally via:

invoke check

Up and running via local filesystem

The example project, cloud_browser_project, is configured to connect to a local sqlite database.

To run:

invoke syncdb run-server

This will start a server for the local filesystem, browsable at http://localhost:8000/, creating a sqlite database in cloud_browser_project/db.

Publishing a release

There are two steps required to publish a new release:

  1. Generate a Python distribution and upload it to PyPI.
  2. Generate the documentation and upload it to Github Pages.

Both steps are automated via Travis CI and get run whenever a release is created on Github. The tag version of the release will be used as the PyPI version identifier and should follow the semantic versioning convention of major.minor.patch.

Alternatively, the release steps can also be run locally via:

# set credentials for PyPI
export TWINE_USERNAME="..."
export TWINE_PASSWORD="..."

# set a personal access token with push access to the repo
export GITHUB_TOKEN="..."

# set the new version number
export BUILD_VERSION="1.2.3"

# run the release
invoke sdist publish-pypi docs publish-docs