Skip to main content

A reusable Python repository starter with packaging, tests, linting, and docs ready for PyPI.

Project description

pyrepo-init

pyrepo-init is a reusable Python repository starter with packaging, tests, linting, documentation, and PyPI publishing configuration already wired in.

Use it as a starting point for small Python packages that should be installable with pip, testable with pytest, and releasable through GitHub Actions.

Installation

pip install pyrepo-init

Usage

from pyrepo_init.main import get_message

print(get_message())

Or via command line:

pyrepo-init
python -m pyrepo_init

Development

python -m pip install --upgrade pip nox
nox -s test
nox -s lint
nox -s docs

Release to PyPI

Before publishing, verify that the package builds cleanly:

python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*

This repository includes .github/workflows/publish-pypi.yml:

  • Manual workflow_dispatch publishes to TestPyPI.
  • Publishing a GitHub release publishes to PyPI.

Configure trusted publishing for shenxianpeng/pyrepo-init on PyPI and TestPyPI before releasing.

License

MIT

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

pyrepo_init-0.2.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyrepo_init-0.2.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file pyrepo_init-0.2.0.tar.gz.

File metadata

  • Download URL: pyrepo_init-0.2.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrepo_init-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0904abdda76bc8cccd46cc7dcbc867c9317ef5ce5b245acfd615cd70df69f3e1
MD5 b2dd928a354b8ded0179ba4eb4177769
BLAKE2b-256 c642adc77fcc7593ad0baf95ab8ec7b7aa6ab0999c69309ad88c5e57e7dc4996

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrepo_init-0.2.0.tar.gz:

Publisher: publish-pypi.yml on shenxianpeng/pyrepo-init

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyrepo_init-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyrepo_init-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrepo_init-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de8a14bb7bbbc090abcebff82328d67827c077308c2512d7ca2dcecdeda271f2
MD5 f24e1e18c684d25778bbfe1d01233b8c
BLAKE2b-256 e87b309a83c184bdf901d5d46ae9e106abbea11e004beb890113e052a48d7e7d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrepo_init-0.2.0-py3-none-any.whl:

Publisher: publish-pypi.yml on shenxianpeng/pyrepo-init

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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