https://github.com/kei-mag/python-package

Template repository for Python package that supports installation with pip, Poetry, Rye and uv.
https://github.com/kei-mag/python-package

hatchling pip poetry pypi-package python3 rye uv

Last synced: 8 months ago
JSON representation

Template repository for Python package that supports installation with pip, Poetry, Rye and uv.

• Host: GitHub
• URL: https://github.com/kei-mag/python-package
• Owner: kei-mag
• License: mit
• Created: 2023-01-12T10:46:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-05-06T03:51:39.000Z (about 1 year ago)
• Last Synced: 2025-07-31T23:04:39.097Z (11 months ago)
• Topics: hatchling, pip, poetry, pypi-package, python3, rye, uv
• Language: Python
• Homepage: https://packaging.python.org/en/latest/tutorials/packaging-projects/
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Python package "my-package"

## Let's get started!

**First, you should rename a directory in the src directory with the name to be used during import like 'my_package'.**

### Directory structure

**src-layout**

```

package_root

├── pyproject.toml

├── requirements.txt

├── ...

└── src/

    └── my_package/

        ├── __init__.py

        ├── ...

        ├── module.py

        └── subpkg1/

            ├── __init__.py

            ├── ...

            └── module1.py

```

## To upload package to PyPI

If you would like to upload this package to pypi.org or test.pypi.org, you must set the API key for test.pypi.org as TEST_PYPI_API_TOKEN and the API key for pypi.org as PYPI_API_TOKEN in the GitHub Actions Secret.

If you wouldn't like to upload this package to PyPI, you need to remove .github/workflows/Publish-to-PyPI.yml or disable it.