Welcome to bootstrap-py’s documentation!

Contents:

Bootstrap Python Package

The bootstrap-py provides generating the Python packages.

Status

https://secure.travis-ci.org/mkouhei/bootstrap-py.png?branch=master https://coveralls.io/repos/mkouhei/bootstrap-py/badge.png?branch=master Documentation Status

Requirements

  • Python 2.7 over or Python 3.3 over or PyPy 2.4.0 over

Features

Usage

Install bootstrap-py

Install bootstrap-py:

$ virtualenv venv
$ . venv/bin/activate
(venv)$ pip install bootstrap-py

Generate Python package

Generate your Python package.:

(venv)$ bootstrap-py create -a 'Your author name' -e 'your-author-email@example.org' \
-u 'https://your-package-website.example.org' -o '/path/to/package-dir' \
-l 'select-the-license' 'your-package-name'
(venv)$ deactivate
$ cd /path/to/package-dir
$ ls
MANIFEST.in  docs     pytest.ini  setup.py  utils
README.rst   libneta  setup.cfg   tox.ini

List license choices

List license description choices.:

(venv)$ bootstrap-py list -l
GPL        : GNU General Public License (GPL)
CPL        : Common Public License
IOSL       : Intel Open Source License
GPLv3+     : GNU General Public License v3 or later (GPLv3+)
(omit)

Using tox

Running test with tox:

$ pip install --user tox
$ tox
(omit)
_______________________________________ summary ______________________________________
py27: commands succeeded
py34: commands succeeded
py35: commands succeeded
pypy: commands succeeded
pep257: commands succeeded
docs: commands succeeded
pychecker: commands succeeded
congratulations :)

References

ChangeLog

0.2.1 (2016-02-16)

  • Fixes failing create sub-command.

0.2.0 (2016-02-15)

  • Adds create, list sub-command.
    • “create”: generating Python package.
    • “list”: Print license description for choices.
  • Changes mutually exclusive group; username, url options.
  • Add checking package name in PyPI.
  • Adds some exception handling.

0.1.1 (2016-02-02)

  • Fixes README template

0.1.0 (2016-02-02)

  • First release

Indices and tables