Skip to main content

# Python Template Repo —

Template Python Repo for getting started with a Python Library with GitHub.

## Benefits

  • GitHub Action Templates

  • Auto deploy to PyPi

  • Issue and Pull Request Templates

  • Auto Configured install and test requires

## To Use

  1. Clone the repo

  2. Rename the [python_GH_template](python_gh_template) directory to the name of your project.
    • Make sure the names updates in [setup.py](setup.py), [lint workflow](.github/workflows/lint.yml).

  3. Install package locally pip install -e .

  4. Add your project requirements to [requirements.txt](requirements.txt).
    • If you have any development requirements add them to [requirements-dev.txt](requirements-dev.txt).

  5. Add tests (or delete if you want)

  6. Change the [License](LICENSE) if desired.

  7. Edit the assignees in [Issue Templates](.github/ISSUE_TEMPLATE), [Pull Request Template](.github/PULL_REQUEST_TEMPLATE) and [Dependabot Config](.github/dependabot.yml).

  8. Edit [setup.py](setup.py) to have relevant links and information.

  9. Add PYPI_USERNAME and PYPI_PASSWORD into the secrets section.

Metadata

Release files for python-gh-template 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-gh-template 1.0.0
File Size Uploaded
python_gh_template-1.0.0.tar.gz 2.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for python-gh-template 1.0.0
File Interpreter ABI Platform
python_gh_template-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.4 kB

Release files / python_gh_template-1.0.0.tar.gz

Download URL python_gh_template-1.0.0.tar.gz
Size 2.4 kB
Tags Source
SHA-256 checksum
How to use checksums
410d2b4e07691277b8efc6f4cfe779978553798ca4bdd727e29b587d22dd42a7
BLAKE2b-256 checksum
How to use checksums
2ad2a09375b4e13a6e7e4e62e300e99d6e9efde780bd74f6e18a336829fd41a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

Release files / python_gh_template-1.0.0-py3-none-any.whl

Download URL python_gh_template-1.0.0-py3-none-any.whl
Size 8.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8c30acf135be8ee4d9b408262ba9be9bd211b57ddcd8ae0bbc603b8d83d9750
BLAKE2b-256 checksum
How to use checksums
59483f6cb1a43922c0927fb67d22652c40b785e314b7db5fe788b1f0ae1df898
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page