Metadata-Version: 2.0
Name: freedom
Version: 0.0.1
Summary: A pure-python git and pypi release management tool
Home-page: https://bitbucket.org/sys-git/releaseme
Author: Francis Horsman
Author-email: francis.horsman@gmail.com
License: UNKNOWN
Keywords: Python release management
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: sh (==1.11)
Requires-Dist: click (==3.3)
Requires-Dist: pyyaml (==3.11)
Requires-Dist: nose (==1.3.1)
Requires-Dist: coverage (==3.7.1)
Requires-Dist: tox (==1.8)
Requires-Dist: gitpython (==0.3.4)
Requires-Dist: sphinx (==1.2.3)
Requires-Dist: sphinx-pypi-upload (==0.2.1)
Requires-Dist: ujson (==1.33)
Requires-Dist: msgpack-python (==0.4.4)
Requires-Dist: six (==1.9.0)
Requires-Dist: flake8 (==2.3.0)
Requires-Dist: pylint (==1.4.0)

# README #

A python release management tool.

[ ![Codeship Status for sys-git/freedom](https://codeship.com/projects/7abb60f0-7d41-0132-fcd7-6602ec740206/status?branch=master)](https://codeship.com/projects/56601)
[![Build Status](https://api.shippable.com/projects/54b500d45ab6cc135288711c/badge?branchName=master)](https://app.shippable.com/projects/54b500d45ab6cc135288711c/builds/latest)

* Version 0.0.1

### How do I get set up? ###

* **python setup.py install**
* Run the tests from source **python setup.py nosetests**
* Dependencies:  None
* How to run tests with all nosetests options set:  **./runtests.sh**
* Deployment instructions (coming soon):  **pip install freedom**



### Requirements ###

At least Python 2.6
Tested on Python 2.7, 3.4.0

### Contribution guidelines ###

I accept pull requests.

### Who do I talk to? ###

* Francis Horsman:  **francis.horsman@gmail.com**

### Example ###

```
>>> python release.py --help

Usage: release.py [OPTIONS]

Options:
  --verbose                 Enabled more verbose output.
  --tag                     tag this release
  --build_release                   build_release this release
  --publish_release                 publish_release to pypi
  --dryrun                  Perform a dry-run (no side effects in git or pypi)
  --profile-env TEXT        Environmental variable which holds profile
                            information in, defaults to RELEASEME_PROFILE.
  --profile TEXT            Load options from this profile file (overrides all
                            other options).
  --history-version TEXT    New version (optional - previous version will be
                            incremented).
  --history-date TEXT       The date to use in the history synopsis when
                            tagging a release.
  --history-comment TEXT    The changelog comment to add.
  --history-file TEXT       The history text file to use.
  --history-delimiter TEXT  The history file synopsis delimiter (just prior to
                            history entries).
  --history-meta TEXT       The history file synopsis (prior to the
                            delimiter).
  --git-profile TEXT        Load options from this git profile file (overrides
                            all other options)
  --git-repo TEXT           Location of the git repo to release (defaults to
                            cwd: /home/francis/PycharmProjects/freedom)
  --help                    Show this message and exit.

```

.. :changelog:

Changelog
=========



