Bootstrap Python Package

The bootstrap-py provides generating the Python packages.

Status

Notes

Genateed package with v0.4.1 or less that has bugs Sphinx documentation. Modify the follows manually.

• Fixes docs/source/index.rst:

  diff --git a/docs/source/index.rst b/docs/source/index.rst
  index b3404ac..d8bdc83 100644
  --- a/docs/source/index.rst
  +++ b/docs/source/index.rst
  @@ -16,8 +16,8 @@ Contents:
  
      CHANGELOG
  
  - Indices and tables
  -===================
  +Indices and tables
  +==================
  
   * :ref:`genindex`
   * :ref:`modindex`
  

• Renames docs/source/README to docs/source/README.rst.

• Fixes documentation version in docs/source/conf.py.

• Fixes auth_email, url in setup.py.

Requirements

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

Features

• Generating Python package.
• Checking Python package name existence at PyPI.
• Test and conde checking environment is configured with the Tox, Pytest, and others.
  • pytest-cov
  • pytest-pep8
  • pytest-flakes
  • Pylint
  • PyChecker
  • pep257
• Generating documentation automatically with the Sphinx.
• Configuration Git repository, initial commit.

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 :)