Skip to main content

Template tool to easily generate your Python packages.

Project description

The bootstrap-py provides generating the Python packages.

Status

https://github.com/mkouhei/bootstrap-py/actions/workflows/ci.yml/badge.svg https://coveralls.io/repos/mkouhei/bootstrap-py/badge.png?branch=master https://img.shields.io/pypi/v/bootstrap-py.svg Documentation 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.

  • 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 'your-author-email@example.org' \
-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 :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bootstrap-py-2.0.0.tar.gz (69.5 kB view hashes)

Uploaded Source

Built Distribution

bootstrap_py-2.0.0-py3-none-any.whl (55.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page