https://github.com/bachya/pypi-template
A template repo for the PyPI-focused Python libraries I tend to develop
https://github.com/bachya/pypi-template
Last synced: about 1 year ago
JSON representation
A template repo for the PyPI-focused Python libraries I tend to develop
- Host: GitHub
- URL: https://github.com/bachya/pypi-template
- Owner: bachya
- License: mit
- Created: 2020-04-21T00:14:25.000Z (about 6 years ago)
- Default Branch: dev
- Last Pushed: 2025-05-12T06:10:39.000Z (about 1 year ago)
- Last Synced: 2025-05-13T04:56:34.063Z (about 1 year ago)
- Language: Shell
- Size: 1.22 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# 🚰 package_name: DESCRIPTION
[![CI][ci-badge]][ci]
[![PyPI][pypi-badge]][pypi]
[![Version][version-badge]][version]
[![License][license-badge]][license]
[![Code Coverage][codecov-badge]][codecov]
[![Maintainability][maintainability-badge]][maintainability]
DESCRIPTION
- [Installation](#installation)
- [Python Versions](#python-versions)
- [Usage](#usage)
- [Contributing](#contributing)
# Installation
```bash
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][contributors] so far!
1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
2. [Fork the repository][fork].
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!
[aiohttp]: https://github.com/aio-libs/aiohttp
[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/package_name/test.yml
[ci]: https://github.com/bachya/package_name/actions
[codecov-badge]: https://codecov.io/gh/bachya/package_name/branch/dev/graph/badge.svg
[codecov]: https://codecov.io/gh/bachya/package_name
[contributors]: https://github.com/bachya/package_name/graphs/contributors
[fork]: https://github.com/bachya/package_name/fork
[issues]: https://github.com/bachya/package_name/issues
[license-badge]: https://img.shields.io/pypi/l/package_name.svg
[license]: https://github.com/bachya/package_name/blob/main/LICENSE
[maintainability-badge]: https://api.codeclimate.com/v1/badges/CHANGE_THIS/maintainability
[maintainability]: https://codeclimate.com/github/bachya/package_name/maintainability
[new-issue]: https://github.com/bachya/package_name/issues/new
[new-issue]: https://github.com/bachya/package_name/issues/new
[pypi-badge]: https://img.shields.io/pypi/v/package_name.svg
[pypi]: https://pypi.python.org/pypi/package_name
[version-badge]: https://img.shields.io/pypi/pyversions/package_name.svg
[version]: https://pypi.python.org/pypi/package_name