generator-python-package

Yeoman generator for python packages.

Getting Started

Make sure you have the latest version of Yeoman:

$ npm install -g yo

To install generator-python-package from npm, run:

$ npm install -g generator-python-package

Install kxxoling/generator-python-package：

$ git clone https://github.com/kxxoling/generator-python-package.git
$ cd generator-python-package && npm link

Finally, initiate the generator:

$ yo python-package

Current features

• Allows selection of supported python versions (2.6, 2.7, 3.2, 3.3, 3.4, pypy);
• Uses nosetests to run your tests;
• Creates base class for tests;
• Uses and configures coverage for test coverage;
• Uses preggy for expectations;
• Uses tox to run tests against all the supported python versions;
• Allows selections of services your app requires (currently supported: mongodb and redis);
• Sets up a setup.py file with all the collected information and test dependencies;
• Creates travis.yml file that runs tests;
• Creates Makefile to support all the above features.

Makefile

To list available tasks, just run:

$ make list

To setup a new virtualenv:

$ make setup

To run your tests:

$ make test

DISCLAIMER

The above tools are my personal preferences and the ones I like to work with.

If you feel any of those can be replaced by a different tool, feel free to make a pull request adding a wizard step to select the tool. Just make sure to keep compatibility with the one already in place.