bootstrap-py 2.0.0

Template tool to easily generate your Python packages.

The bootstrap-py provides generating the Python packages.

Status

Requirements

• Python 3.9 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.

  • pycodestyle

  • pytest-cov

  • pytest-flake8

  • pydocstyle

• Generating documentation automatically with the Sphinx.

• Configuration Git repository, initial commit.

• Generate sample code using --with-samples option.

Usage

Install bootstrap-py

Install bootstrap-py:

$ python -m venv .venv
$ python -m pip install bootstrap-py

Generate Python package

Generate your Python package.:

$ .venv/bin/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'
$ ls -a package-dir
.  ..  .coveragerc  .git  .github  .gitignore  MANIFEST.in  README.rst  docs  pyproject.toml  src  tox.ini  utils

List license choices

List license description choices.:

$ .venv/bin/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 ______________________________________
py311: commands succeeded
flake8: commands succeeded
pycodetyle: commands succeeded
pydocstyle: commands succeeded
docs: commands succeeded
congratulations :)