lycantropos/seek-well repository overview

⁠seek-well

In what follows python3 is an alias for python3.6 or any later version.

⁠Installation

Install the latest pip & setuptools packages versions

python3 -m pip install --upgrade pip setuptools

⁠Release

Download and install the latest stable version from PyPI repository

python3 -m pip install --upgrade seek-well

⁠Developer

Download and install the latest version from GitHub repository

git clone https://github.com/lycantropos/seek-well.git
cd seek-well
python3 setup.py install

⁠Bumping version

Install bumpversion⁠.

Choose which version number category to bump following semver specification⁠.

Test bumping version

bumpversion --dry-run --verbose $VERSION

where $VERSION is the target version number category name, possible values are patch/minor/major.

Bump version

bumpversion --verbose $VERSION

Note: to avoid inconsistency between branches and pull requests, bumping version should be merged into master branch as separate pull request.

⁠Running tests

Plain

python3 setup.py test

Inside Docker container

docker-compose up

Inside Docker container with remote debugger

./set-dockerhost.sh docker-compose up

Bash script (e.g. can be used in Git hooks)

./run-tests.sh