A clean, automated setup for publishing simple Python packages to PyPI and Anaconda.
Project description
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_poetry
folder to<package_name>
- Replace all
simple_poetry
instance in files to<package_name>
- Replace all
simple-poetry
instance in files to<package-name>
- Replace all
3.8
instance in files to<target-python-version>
- Replace
ppeetteerrs
with<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 andmkdocstrings
preferences (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 Tests
step 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
commit
andpush
your changes- Create first release
- Go to
Settings
and activate your GitHub Pages using thegh-pages
branch
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
simple-poetry-0.1.0.tar.gz
(3.4 kB
view hashes)
Built Distribution
Close
Hashes for simple_poetry-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 096337b944f80b48892c0908995b2b6b5d898172e82d46db609c53ce0b1b1161 |
|
MD5 | 83dac007e469f42efc9f6bd314a079ba |
|
BLAKE2b-256 | 87473d6185147a3133d04ae22b481305c17cca1ec310a22205673b6762304445 |