Skip to content

README_TEMPLATE.md

Latest commit

 

History

History
60 lines (39 loc) · 1.54 KB

README_TEMPLATE.md

File metadata and controls

60 lines (39 loc) · 1.54 KB
Raw

Package Name

Run tests Coverage License: ISC REUSE

Package description.

Installation

pip install package-name

Usage

from package_name import example_function

result = example_function()
print(result)

Documentation

Full documentation is available at: https://opencitations.github.io/python-package-template/

Development

This project uses UV for dependency management.

Setup

# Clone the repository
git clone https://github.com/opencitations/python-package-template.git
cd python-package-template

# Install dependencies
uv sync --all-extras --dev

Running tests

uv run pytest tests/

Building documentation locally

uv run jupyter-book build --builder dirhtml docs

The site is written to docs/_build/dirhtml/.

License

This project is licensed under the ISC License - see the LICENSE.md file for details.