changes 0.1.1

# changes

[](http://travis-ci.org/michaeljoseph/changes)
[](https://waffle.io/michaeljoseph/changes)
[](http://badge.fury.io/py/changes)
[](https://crate.io/packages/changes?version=latest)
[](https://coveralls.io/r/michaeljoseph/changes?branch=master)

:musical_note: [Ch-ch-ch-ch-changes](http://www.youtube.com/watch?v=pl3vxEudif8) :musical_note:


## Overview

Manages the release of a python library.

* cli that follows [semantic versioning][0] principles to increment the current version
* auto generates a changelog entry (using github's compare view)
* tags the github repo
* uploads to pypi

## Usage

An application wanting to use `changes` must meet these requirements:

* `setup.py`
* `CHANGELOG.md`
* `app_name/__init__.py` with `__version__` and `__url__`

Install `changes`:

pip install changes

Run the cli:

```
changes.

Usage:
changes [options] <app_name> release
changes [options] <app_name> version
changes [options] <app_name> changelog
changes [options] <app_name> tag
changes [options] <app_name> upload
changes -h | --help

Options:
--new-version=<ver> Specify version.
-p --patch Patch-level version increment.
-m --minor Minor-level version increment.
-M --major Minor-level version increment.

-h --help Show this screen.

--pypi=<pypi> Specify alternative pypi
--dry-run Prints the commands that would have been executed.
--commit-changelog Should the automatically generated changelog be
committed?
--debug Debug output.
```

The default workflow is to run the `changelog` command to autogenerate
a changelog entry based on your commit messages. You're probably going to
want to edit that a bit, so `changes` won't commit it, unless you
`--commit-changelog`.

The remaining tasks can be automated with the `release` command.

## Documentation

[API Documentation][1]

## Testing ##

Install development requirements:

pip install -r requirements.txt

Tests can then be run by doing:

nosetests

Run the linting (pep8, pyflakes) with:

flake8 changes tests

## API documentation

To generate the documentation:

cd docs && PYTHONPATH=.. make singlehtml

To monitor changes to Python files and execute pep8, pyflakes, and nosetests
automatically, execute the following from the root project directory:

stir


[0]:http://semver.org
[1]:http://changes.rtfd.org