Skip to main content

Format any code-like snippet in an indented style.

Project description

python-starter

A straightforward starter template for Python packages.

Includes things like:

  • All necessary files and paths in .gitignore
  • setup.cfg configuration
  • Local development using requirements.txt and requirements-dev.txt
  • Tools like mypy, black and pytest set up out of the box

Setup

  • Clone this repo and delete .git
  • Rename src/sample_package folder to your package name
  • Rename the package import in tests/sample_test.py
  • Edit the marked fields in setup.cfg, and remove comments
  • Edit LICENSE
  • Setup and activate a virtualenv
  • Run pip install -r requirements-dev.txt
  • That's it! See if it worked by running mycommand and python -m <package name>

Testing

Run pytest

Type Checking

Run mypy .

Create and upload a package to PyPI

Make sure to bump the version in setup.cfg.

Then run the following commands:

rm -rf build dist
python setup.py sdist bdist_wheel

Then upload it to PyPI using twine:

twine upload dist/*

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

indentify-0.0.1.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

indentify-0.0.1-py3-none-any.whl (3.4 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