https://github.com/tktech/python-standard
My standard Python workflow action.
https://github.com/tktech/python-standard
Last synced: 4 days ago
JSON representation
My standard Python workflow action.
- Host: GitHub
- URL: https://github.com/tktech/python-standard
- Owner: TkTech
- Created: 2024-06-18T03:23:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T04:32:12.000Z (over 1 year ago)
- Last Synced: 2025-03-10T06:37:38.622Z (about 1 year ago)
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python-standard
Re-usable github workflows for a typical pure-python project flow. These
are only meant to work with a specific project layout and may not work for
your project.
## Usage
Example project layout:
```
.
├── .github
│ └── workflows
│ ├── release.yml
│ └── test.yml
├── docs
│ ├── conf.py
│ ├── index.rst
│ └── makefile
├──
│ └── __init__.py
├── pyproject.toml
```
### Running tests
The following inputs are available for test workflows:
| Name | Description | Default |
|------------------|---------------------------------------|----------------------|
| use_poetry | Use poetry for dependency management. | false |
| use_sphinx | Use sphinx for documentation. | false |
| use_black | Use black for code formatting. | false |
| python_version | Python version to use. | 3.11 |
| platform | Platform to run the workflow on. | ubuntu-latest |
| black_path | Path to run black on. | . |
| requirements | Path to the requirements file | requirements.txt |
| requirements_dev | Path to the requirements dev file | requirements_dev.txt |
And an example workflow:
```yaml
name: Tests
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
test:
name: Running tests.
uses: tktech/python-standard/.github/workflows/test.yml@v1
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", pypy3.9]
with:
use_poetry: true
use_sphinx: true
use_black: true
python_version: ${{ matrix.python-version }}
```
### Making Releases
The following inputs are available for release workflows:
| Name | Description | Default |
|----------------|-------------------------------------------------------|---------------|
| use_poetry | Use poetry for dependency management. | false |
| use_sphinx | Use sphinx for documentation and push to github-pages | false |
| python_version | Python version to use. | 3.11 |
| platform | Platform to run the workflow on. | ubuntu-latest |
Make sure you have a ``PYPI_TOKEN`` secret set up in your repository secrets,
and run the job with the `pages: write` permission to push the documentation
to github pages.
```yaml
on:
workflow_dispatch:
release:
types:
- published
name: Release
jobs:
build:
permissions:
id-token: write
pages: write
uses: tktech/python-standard/.github/workflows/release.yml@v1
with:
use_poetry: true
use_sphinx: true
python_version: '3.11'
platform: 'ubuntu-latest'
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
```
This example will build and publish your package to pypi when you create &
publish a release on github.
## Why?
Because I have far too many Python projects and github deprecates things far
too often.