bootstrap-py 0.4.6

Bootstrap Python package

==========================
Bootstrap Python Package
==========================

The ``bootstrap-py`` provides generating the Python packages.

Status
======

.. image:: https://secure.travis-ci.org/mkouhei/bootstrap-py.png?branch=master
:target: http://travis-ci.org/mkouhei/bootstrap-py
.. image:: https://coveralls.io/repos/mkouhei/bootstrap-py/badge.png?branch=master
:target: https://coveralls.io/r/mkouhei/bootstrap-py?branch=master
.. image:: https://img.shields.io/pypi/v/bootstrap-py.svg
:target: https://pypi.python.org/pypi/bootstrap-py
.. image:: https://readthedocs.org/projects/bootstrap-py/badge/?version=latest
:target: https://readthedocs.org/projects/bootstrap-py/?badge=latest
:alt: Documentation Status

Notes
=====

v0.4.6
------

Generated package with v0.4.5 or less that has bugs .travis.yml configuration file.
Modify the follows manually.::

diff --git a/.travis.yml b/.travis.yml
index ab128da..600125e 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -14,6 +14,11 @@ after_success:
- coveralls --verbose

matrix:
+ allow_failures:
+ - env: TOX_ENV=py27
+ - env: TOX_ENV=py33
+ - env: TOX_ENV=py34
+ - env: TOX_ENV=pypy
include:
- python: 3.5
- env: TOX_ENV=py35
+ - python: 3.5
+ env: TOX_ENV=py35

v0.4.5
------

Generated package with v0.4.4 or less that has bugs tox.ini configuration file.
Modify the follows manually.

* Fixes `your_package_name` with snake case.
Modify the follows manually.::

diff --git a/tox.ini b/tox.ini
index a9d823f..db825cc 100644
--- a/tox.ini
+++ b/tox.ini
@@ -49,7 +49,7 @@ basepython = pypy
[testenv:pep257]
deps=
pep257
-commands = pep257 bootstrap_py
+commands = pep257 your_package_name
basepython = python3.5

[testenv:docs]


v0.4.4
------

Generated package with v0.4.3 or less that has bugs pre-commit hook script.
Modify the follows manually.::

$ chmod +x utils/pre-commit
$ ln -s ../../utils/pre-commit .git/hooks/pre-commit


v0.4.2
------

Genarated 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 <https://pypi.python.org/pypi/tox>`_, `Pytest <http://pytest.org/latest-ja/>`_, and others.

* `pytest-cov <https://pypi.python.org/pypi/pytest-cov>`_
* `pytest-pep8 <https://pypi.python.org/pypi/pytest-pep8>`_
* `pytest-flakes <https://pypi.python.org/pypi/pytest-flakes>`_
* `Pylint <http://www.pylint.org/>`_
* `PyChecker <http://pychecker.sourceforge.net/>`_
* `pep257 <https://github.com/GreenSteam/pep257/>`_

* Generating documentation automatically with the `Sphinx <http://www.sphinx-doc.org/en/stable/>`_.
* 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 '[e-mail]' \
-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 :)

ChangeLog
=========

0.4.6 (2016-04-21)
------------------

* Fixes .travis.yml template.

0.4.5 (2016-04-06)
------------------

* Fixes tox.ini template.

0.4.4 (2016-04-05)
------------------

* Adds symlink to pre-commit hook.

0.4.3 (2016-04-04)
------------------

* Fixes pre-commit hook script permission.

0.4.2 (2016-03-08)
------------------

* Fixes configiratuon version, release.
* Fixes url, author_email in setup.py.

0.4.1 (2016-03-07)
------------------

* Adds exception handler package update.
* Fixes some docstring.

0.4.0 (2016-03-07)
------------------

* Adds checking latest version.
* Fixes Sphinx template bugs.
* Does some refactoring.

0.3.0 (2016-02-21)
------------------

* git init and initial commit.
* Adds --no-check option.
* Fixes list subcommand.

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