pypi-template

A template for creating a Python package and publishing it to PyPI.

Included Boilerplate

This template includes ready-to-use configuration for:

• Poetry: Modern Python packaging and dependency management
• Ruff: Fast Python linter and formatter
• pre-commit: Git hooks to enforce code quality
• Sphinx: Documentation generation with auto-API docs
• mypy: Static type checking
• pytest: Testing framework with coverage reports
• Read the Docs: Documentation hosting

your_package_name

Your package description goes here. Provide a brief overview of what your package does and its main benefits.

Overview

your_package_name is a Python package that [brief description]. It enables developers to:

• Feature 1: Description of feature 1
• Feature 2: Description of feature 2
• Feature 3: Description of feature 3
• Feature 4: Description of feature 4

Key Features

• Feature Category 1

  • Subfeature 1.1
  • Subfeature 1.2
  • Subfeature 1.3
  • Subfeature 1.4

• Feature Category 2

  • Subfeature 2.1
  • Subfeature 2.2
  • Subfeature 2.3
  • Subfeature 2.4

• Feature Category 3

  • Subfeature 3.1
  • Subfeature 3.2
  • Subfeature 3.3
  • Subfeature 3.4

• Feature Category 4

  • Subfeature 4.1
  • Subfeature 4.2
  • Subfeature 4.3
  • Subfeature 4.4

Installation

pip install your_package_name

Or with Poetry:

poetry add your_package_name

Quick Example

from your_package_name import YourClass, your_function

# Example code showing how to use your package
result = your_function("example input")
print(result)

# Example using a class
instance = YourClass(parameter="value")
output = instance.method()

Documentation

For detailed documentation, visit your_package_name.readthedocs.io.

The documentation includes:

• Getting Started Guide
• API Reference
• Examples and Tutorials
• FAQ

Contributing

We welcome contributions! Please check out our contributing guidelines for details on:

• Setting up your development environment
• Running tests
• Submitting pull requests

License

This project is licensed under the GNU General Public License v3.0 (GPLv3).