mine 0.0.0

TBD

mine

TBD

Getting Started

Requirements

• Python 3.3+

Installation

Mine can be installed with pip:

$ pip install mine

or directly from the source code:

$ git clone https://github.com/jacebrowning/mine.git
$ cd mine
$ python setup.py install

Basic Usage

After installation, abstract base classes can be imported from the package:

$ python
>>> import mine
mine.__version__

For Contributors

Requirements

• Make:

  • Windows: http://cygwin.com/install.html

  • Mac: https://developer.apple.com/xcode

  • Linux: http://www.gnu.org/software/make (likely already installed)

• virtualenv: https://pypi.python.org/pypi/virtualenv#installation

• Pandoc: http://johnmacfarlane.net/pandoc/installing.html

• Graphviz: http://www.graphviz.org/Download.php

Installation

Create a virtualenv:

$ make env

Run the tests:

$ make test
$ make tests  # includes integration tests

Build the documentation:

$ make doc

Run static analysis:

$ make pep8
$ make pep257
$ make pylint
$ make check  # includes all checks

Prepare a release:

$ make dist  # dry run
$ make upload

Changelog

0.0.0 (2013/10/09)

• <Change the version, date, and this text.>