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

Uploaded Source

Built Distribution

indentify-0.0.1-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file indentify-0.0.1.tar.gz.

File metadata

  • Download URL: indentify-0.0.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.7

File hashes

Hashes for indentify-0.0.1.tar.gz
Algorithm Hash digest
SHA256 eaeb008c82927557ac0920e67d358fa3930a161d3404343697de6f540c776c00
MD5 00ebe293b7affe0567c79f8f8dbc3d9b
BLAKE2b-256 e7a439821c7cd213e6009493050c1ff1a6f5a9b3dff2008d39cc1f0cb653396f

See more details on using hashes here.

File details

Details for the file indentify-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: indentify-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.7

File hashes

Hashes for indentify-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a1314abd9f95ace98b6f056a543d8dced36529812277b38490759b6860e5c4b3
MD5 c2ad18bd3520e185700e069adabccc93
BLAKE2b-256 2b970d1f71732e562ca7a15941136cad1c2684ea8c8ccf80e55af15223ab6885

See more details on using hashes here.

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