Metadata-Version: 2.4
Name: lfreleng-test-python-project
Version: 0.0.1
Summary: Sample Python project used for testing actions
Project-URL: Homepage, https://github.com/lfreleng-actions/test-python-project
Project-URL: Repository, https://github.com/lfreleng-actions/test-python-project
Project-URL: Downloads, https://github.com/lfreleng-actions/test-python-project/releases
Project-URL: Bug Tracker, https://github.com/lfreleng-actions/test-python-project/issues
Project-URL: Documentation, https://github.com/lfreleng-actions/test-python-project/tree/main/docs
Project-URL: Source Code, https://github.com/lfreleng-actions/test-python-project
Author-email: Matthew Watkins <93649628+ModeSevenIndustrialSolutions@users.noreply.github.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.11
Requires-Dist: typer>=0.15.2
Provides-Extra: dev
Requires-Dist: coverage>=7.7.1; extra == 'dev'
Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
Requires-Dist: pytest>=8.3.5; extra == 'dev'
Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
Requires-Dist: sphinx>=8.2.3; extra == 'dev'
Requires-Dist: tox>=4.24.2; extra == 'dev'
Description-Content-Type: text/markdown

# Test Python Project

<!--
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: 2025 The Linux Foundation
-->

<!-- prettier-ignore-start -->
<!-- markdownlint-disable-next-line MD013 -->
[![Linux Foundation](https://img.shields.io/badge/Linux-Foundation-blue)](https://linuxfoundation.org/) [![Source Code](https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white&color=blue)](https://github.com/lfreleng-actions/test-python-project) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![pre-commit.ci status badge]][pre-commit.ci results page] [![PyPI](https://img.shields.io/pypi/v/lfreleng-test-python-project?logo=python&logoColor=white&color=blue)](https://pypi.org/project/lfreleng-test-python-project) [![🔐 CodeQL](https://github.com/lfreleng-actions/test-python-project/actions/workflows/codeql.yml/badge.svg)](https://github.com/lfreleng-actions/test-python-project/actions/workflows/codeql.yml) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/lfreleng-actions/test-python-project/badge)](https://scorecard.dev/viewer/?uri=github.com/lfreleng-actions/test-python-project)

[![testpypi](https://img.shields.io/pypi/v/lfreleng-test-python-project?logo=python&label=testpypi&logoColor=white&color=32C955&pypiBaseUrl=https://test.pypi.org)](https://test.pypi.org/project/lfreleng-test-python-project)
<!-- prettier-ignore-end -->

Example project used for testing Github actions that work with Python code.

Project name: lfreleng-test-python-project

## test-python-project

<!-- markdownlint-disable MD013 -->
Contains a sample Python project implementing a CLI tool with [Typer](https://typer.tiangolo.com/).
<!-- markdownlint-enable MD013 -->

<!--
# The section below renders the badges displayed at the top of the page
-->

## Notes

Steps required to build and work with the project using uv:

```console
# Install dependencies
uv sync --all-extras

# Build the project
uv build

# Run tests
uv run pytest

# Run tests with tox
uv run tox

# Install in development mode
uv pip install -e .
```

The project uses `hatchling` with dynamic versioning from VCS tags. Version
numbers are automatically generated from git tags.

[pre-commit.ci results page]: https://results.pre-commit.ci/latest/github/lfreleng-actions/test-python-project/main
[pre-commit.ci status badge]: https://results.pre-commit.ci/badge/github/lfreleng-actions/test-python-project/main.svg
