Skip to content
/ pypi-template Public template

A template repo for the PyPI-focused Python libraries I tend to develop

License

Notifications You must be signed in to change notification settings

bachya/pypi-template

Repository files navigation

🚰 package_name: DESCRIPTION

CI PyPI Version License Code Coverage Maintainability

Buy Me A Coffee

DESCRIPTION

Installation

pip install package_name

Python Versions

package_name is currently supported on:

  • Python 3.10
  • Python 3.11
  • Python 3.12

Usage

Contributing

Thanks to all of our contributors so far!

  1. Check for open features/bugs or initiate a discussion on one.
  2. Fork the repository.
  3. (optional, but highly recommended) Create a virtual environment: python3 -m venv .venv
  4. (optional, but highly recommended) Enter the virtual environment: source ./.venv/bin/activate
  5. Install the dev environment: script/setup
  6. Code your new feature or bug fix on a new branch.
  7. Write tests that cover your new functionality.
  8. Run tests and ensure 100% code coverage: poetry run pytest --cov package_name tests
  9. Update README.md with any new documentation.
  10. Submit a pull request!

About

A template repo for the PyPI-focused Python libraries I tend to develop

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published