Skip to main content

Basic template of a python repository

Project description

Basic Repo Template

This is a basic template repository for a python project.

Change the package_name in: pyproject.toml to the name of your package (doing a search and replace for the default string mprib_tools being careful to check folder and file names) NOTE - This is pretty clunky and will be automated via a cookiecutter template "soon."

You'll also want to change the name, email etc in pyproject.toml and {repository_name}.__init__.py to your own details.

Publishing to PyPi (to make it pip installable)

NOTE - These instructions haven't been tested yet, this is placeholder text (written 2023-01-19)

You'll need to create a PyPi account and then create an API token for the Github Action configured in the file: .github/workflows/publish_to_pypi_when_new_tag_is_pushed_to_main.yml

These instructions may help you set that up! https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

Basic Setup

Clone the repo

Create a venv with:

python -m venv .venv

Make sure that .venv is active

From within the repo (which will have a subfolder named after the package), build the local wheel of the package:

python -m pip install -e .

This is a small change to test autopublish.

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

mprib_tools-2023.1.1008.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

mprib_tools-2023.1.1008-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file mprib_tools-2023.1.1008.tar.gz.

File metadata

  • Download URL: mprib_tools-2023.1.1008.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for mprib_tools-2023.1.1008.tar.gz
Algorithm Hash digest
SHA256 fe8641f2de70c2517f79962d88bc427d7709db476cfe5c655ac98d1563c4296e
MD5 366beb0cf00586c343aba57a999469a4
BLAKE2b-256 576dea2882bd48cf2dbc22b9fddcd189a331edd6f3c25e8c1d2a0208b4f26c1b

See more details on using hashes here.

File details

Details for the file mprib_tools-2023.1.1008-py3-none-any.whl.

File metadata

File hashes

Hashes for mprib_tools-2023.1.1008-py3-none-any.whl
Algorithm Hash digest
SHA256 2722dc48066cb7bd22f2923d34a0d2c7ad1706dd2e04aa68d1d655011015d4a6
MD5 ce7c6815a906f7f1e89696fd3ffdff66
BLAKE2b-256 909314dca8b027ed4d69a0519f5e81dc6d8d149b8854625f650a38ceafa2bf39

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