Development¶

Acquiring the source code¶

Clone the repository to your computer:

$ git clone git://github.com/nielsvm/tagrenamer

$ cd tagrenamer/

Or download the tarball:

$ curl -OJL https://github.com/nielsvm/tagrenamer/tarball/master

Install Tagrenamer into your home folder like this:

$ pipx install tagrenamer

$ tagrenamer --help

$ make venv
$ source venv/bin/activate
$ python3 -m pip install --editable .

$ tagrenamer --help

Regardless of how you installed it, uninstall using pip:

$ pip3 uninstall tagrenamer

$ make venv
$ source venv/bin/activate
$ make docs

Constant documentation build during editing:

$ make servedocs

$ bumpversion --allow-dirty --new-version x.x.x major
$ nano CHANGELOG.rst
$ git add -p
$ git commit -m "version bump"

$ git tag x.x.x
$ git push --tags

$ make venv
$ source venv/bin/activate

$ make dist
$ make release

$ curl -X POST -d "branches=master" -d "token=..." https://readthedocs.org/api/v2/webhook/tagrenamer/.../