Simple Poetry
A clean, automated setup for publishing simple Python packages to PyPI using Poetry and GitHub Actions.
Setup
-
Prepare GitHub repo
- Create new GitHub repository / fork this repository
- Setup PyPI Credentials in repository secrets
PYPI_TOKEN: PyPI API token
-
Replace text in files
- Rename
simple_poetryfolder to<package_name> - Replace all
simple_poetryinstance in files to<package_name> - Replace all
simple-poetryinstance in files to<package-name> - Replace all
3.8instance in files to<target-python-version> - Replace
ppeetteerrswith<github_user_name>
- Rename
-
Enter Package Information
pyproject.toml: Project description, authors<package_name>/__init__.py: Author and emailREADME.md: Customize it, change the name and description especially
-
Further Customizations
mkdocs.yaml: Edit theme andmkdocstringspreferences (Can also add sub-pages to API Reference etc.).devcontainer.json: Add preferred extensions / build configurations (e.g. use GPUs)Dockerfile: Install necessary formatters / linters / packages for local testingdocs/: Write your documentation.github/workflows/push.yaml: Remove thetests::Run Testsstep if you need to run tests locally (e.g. if your tests require GPU). Keep the rest to upload Codecov.
-
Publish and Setup GitHub Pages
commitandpushyour changes- Create first release
- Go to
Settingsand activate your GitHub Pages using thegh-pagesbranch
Metadata
Release files for simple-poetry 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| simple-poetry-0.1.0.tar.gz | 3.4 kB | Without provenance | Details for simple-poetry-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| simple_poetry-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for simple_poetry-0.1.0-py3-none-any.whl |
Total release size: 7.0 kB
Release files / simple-poetry-0.1.0.tar.gz
| Download URL | simple-poetry-0.1.0.tar.gz |
|---|---|
| Size | 3.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e2d848786f5a3d1243a63cf6d0e98df30ca5c692981ce2aad9d7562d24e4aa1
|
|
BLAKE2b-256 checksum How to use checksums |
16cade654b5b3685975d3fae50241646e6124b7e1a288804d935f7b0119651a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.8.12 Linux/5.11.0-1028-azure
|
Release files / simple_poetry-0.1.0-py3-none-any.whl
| Download URL | simple_poetry-0.1.0-py3-none-any.whl |
|---|---|
| Size | 3.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
096337b944f80b48892c0908995b2b6b5d898172e82d46db609c53ce0b1b1161
|
|
BLAKE2b-256 checksum How to use checksums |
87473d6185147a3133d04ae22b481305c17cca1ec310a22205673b6762304445
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.8.12 Linux/5.11.0-1028-azure
|
Security for simple-poetry 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.