https://github.com/lfreleng-actions/test-python-project

Sample Python project used for testing actions
https://github.com/lfreleng-actions/test-python-project

example package python test testing

Last synced: 5 months ago
JSON representation

Sample Python project used for testing actions

• Host: GitHub
• URL: https://github.com/lfreleng-actions/test-python-project
• Owner: lfreleng-actions
• License: other
• Created: 2025-03-13T14:13:29.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-08-25T18:14:08.000Z (5 months ago)
• Last Synced: 2025-08-25T20:25:21.188Z (5 months ago)
• Topics: example, package, python, test, testing
• Language: Python
• Homepage:
• Size: 306 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Test Python Project

[![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)

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

Project name: lfreleng-test-python-project

## test-python-project

Contains a sample Python project implementing a CLI tool with [Typer](https://typer.tiangolo.com/).

##  Notes

Steps required to initialise pyproject.toml and create initial lock file:

```console

pdm init

pdm add -dG test pytest

pdm add -dG test coverage

pdm add -dG tox tox-pdm tox

pdm add -dG lint pre-commit

pdm add -dG docs sphinx

pdm add -dG docs sphinx-copybutton

pdm build

pdm install --dev

```

[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