Skip to content

Commit 88b784b

Browse files
PsiACEPsiACE
committed
feat: init with template
0 parents  commit 88b784b

File tree

17 files changed

+1051
-0
lines changed

17 files changed

+1051
-0
lines changed

‎.github/actions/setup-python-env/action.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: "Setup Python Environment"
2+
description: "Set up Python environment for the given Python version"
3+
4+
inputs:
5+
python-version:
6+
description: "Python version to use"
7+
required: true
8+
default: "3.12"
9+
uv-version:
10+
description: "uv version to use"
11+
required: true
12+
default: "0.6.14"
13+
14+
runs:
15+
using: "composite"
16+
steps:
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: ${{ inputs.python-version }}
20+
21+
- name: Install uv
22+
uses: astral-sh/setup-uv@v6
23+
with:
24+
version: ${{ inputs.uv-version }}
25+
enable-cache: 'true'
26+
cache-suffix: ${{ matrix.python-version }}
27+
28+
- name: Install Python dependencies
29+
run: uv sync --frozen
30+
shell: bash

‎.github/workflows/main.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Main
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
types: [opened, synchronize, reopened, ready_for_review]
9+
10+
jobs:
11+
quality:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Check out
15+
uses: actions/checkout@v4
16+
17+
- uses: actions/cache@v4
18+
with:
19+
path: ~/.cache/pre-commit
20+
key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
21+
22+
- name: Set up the environment
23+
uses: ./.github/actions/setup-python-env
24+
25+
- name: Run checks
26+
run: make check
27+
28+
tests-and-type-check:
29+
runs-on: ubuntu-latest
30+
strategy:
31+
matrix:
32+
python-version: ["3.10", "3.11", "3.12", "3.13"]
33+
fail-fast: false
34+
defaults:
35+
run:
36+
shell: bash
37+
steps:
38+
- name: Check out
39+
uses: actions/checkout@v4
40+
41+
- name: Set up the environment
42+
uses: ./.github/actions/setup-python-env
43+
with:
44+
python-version: ${{ matrix.python-version }}
45+
46+
- name: Run tests
47+
run: uv run python -m pytest tests
48+
49+
- name: Check typing
50+
run: uv run ty check
51+
52+
check-docs:
53+
runs-on: ubuntu-latest
54+
steps:
55+
- name: Check out
56+
uses: actions/checkout@v4
57+
58+
- name: Set up the environment
59+
uses: ./.github/actions/setup-python-env
60+
61+
- name: Check if documentation can be built
62+
run: uv run mkdocs build -s

‎.github/workflows/on-release-main.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: release-main
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
9+
set-version:
10+
runs-on: ubuntu-24.04
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Export tag
15+
id: vars
16+
run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
17+
if: ${{ github.event_name == 'release' }}
18+
19+
- name: Update project version
20+
run: |
21+
sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
22+
env:
23+
RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
24+
if: ${{ github.event_name == 'release' }}
25+
26+
- name: Upload updated pyproject.toml
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: pyproject-toml
30+
path: pyproject.toml
31+
32+
publish:
33+
runs-on: ubuntu-latest
34+
needs: [set-version]
35+
steps:
36+
- name: Check out
37+
uses: actions/checkout@v4
38+
39+
- name: Set up the environment
40+
uses: ./.github/actions/setup-python-env
41+
42+
- name: Download updated pyproject.toml
43+
uses: actions/download-artifact@v4
44+
with:
45+
name: pyproject-toml
46+
47+
- name: Build package
48+
run: uv build
49+
50+
- name: Publish package
51+
run: uv publish
52+
env:
53+
UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
54+
55+
deploy-docs:
56+
needs: publish
57+
runs-on: ubuntu-latest
58+
steps:
59+
- name: Check out
60+
uses: actions/checkout@v4
61+
62+
- name: Set up the environment
63+
uses: ./.github/actions/setup-python-env
64+
65+
- name: Deploy documentation
66+
run: uv run mkdocs gh-deploy --force
67+

‎.gitignore‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
docs/source
2+
3+
# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
4+
5+
# Byte-compiled / optimized / DLL files
6+
__pycache__/
7+
*.py[codz]
8+
*$py.class
9+
10+
# C extensions
11+
*.so
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
share/python-wheels/
28+
*.egg-info/
29+
.installed.cfg
30+
*.egg
31+
MANIFEST
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.nox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
*.py.cover
54+
.hypothesis/
55+
.pytest_cache/
56+
cover/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
78+
# PyBuilder
79+
.pybuilder/
80+
target/
81+
82+
# Jupyter Notebook
83+
.ipynb_checkpoints
84+
85+
# IPython
86+
profile_default/
87+
ipython_config.py
88+
89+
# pyenv
90+
# For a library or package, you might want to ignore these files since the code is
91+
# intended to run in multiple environments; otherwise, check them in:
92+
# .python-version
93+
94+
# pipenv
95+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
97+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
98+
# install all needed dependencies.
99+
#Pipfile.lock
100+
101+
# UV
102+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
103+
# This is especially recommended for binary packages to ensure reproducibility, and is more
104+
# commonly ignored for libraries.
105+
#uv.lock
106+
107+
# poetry
108+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
109+
# This is especially recommended for binary packages to ensure reproducibility, and is more
110+
# commonly ignored for libraries.
111+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
112+
#poetry.lock
113+
#poetry.toml
114+
115+
# pdm
116+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
118+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
119+
#pdm.lock
120+
#pdm.toml
121+
.pdm-python
122+
.pdm-build/
123+
124+
# pixi
125+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
126+
#pixi.lock
127+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
128+
# in the .venv directory. It is recommended not to include this directory in version control.
129+
.pixi
130+
131+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
132+
__pypackages__/
133+
134+
# Celery stuff
135+
celerybeat-schedule
136+
celerybeat.pid
137+
138+
# SageMath parsed files
139+
*.sage.py
140+
141+
# Environments
142+
.env
143+
.envrc
144+
.venv
145+
env/
146+
venv/
147+
ENV/
148+
env.bak/
149+
venv.bak/
150+
151+
# Spyder project settings
152+
.spyderproject
153+
.spyproject
154+
155+
# Rope project settings
156+
.ropeproject
157+
158+
# mkdocs documentation
159+
/site
160+
161+
# mypy
162+
.mypy_cache/
163+
.dmypy.json
164+
dmypy.json
165+
166+
# Pyre type checker
167+
.pyre/
168+
169+
# pytype static type analyzer
170+
.pytype/
171+
172+
# Cython debug symbols
173+
cython_debug/
174+
175+
# PyCharm
176+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
177+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
178+
# and can be added to the global gitignore or merged into this file. For a more nuclear
179+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
180+
#.idea/
181+
182+
# Abstra
183+
# Abstra is an AI-powered process automation framework.
184+
# Ignore directories containing user credentials, local state, and settings.
185+
# Learn more at https://abstra.io/docs
186+
.abstra/
187+
188+
# Visual Studio Code
189+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
190+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
191+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
192+
# you could uncomment the following to ignore the entire vscode folder
193+
# .vscode/
194+
195+
# Ruff stuff:
196+
.ruff_cache/
197+
198+
# PyPI configuration file
199+
.pypirc
200+
201+
# Cursor
202+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
203+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
204+
# refer to https://docs.cursor.com/context/ignore-files
205+
.cursorignore
206+
.cursorindexingignore
207+
208+
# Marimo
209+
marimo/_static/
210+
marimo/_lsp/
211+
__marimo__/

‎.pre-commit-config.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: "v5.0.0"
4+
hooks:
5+
- id: check-case-conflict
6+
- id: check-merge-conflict
7+
- id: check-toml
8+
- id: check-yaml
9+
- id: check-json
10+
exclude: ^.devcontainer/devcontainer.json
11+
- id: pretty-format-json
12+
exclude: ^.devcontainer/devcontainer.json
13+
args: [--autofix, --no-sort-keys]
14+
- id: end-of-file-fixer
15+
- id: trailing-whitespace
16+
17+
- repo: https://github.com/astral-sh/ruff-pre-commit
18+
rev: "v0.12.7"
19+
hooks:
20+
- id: ruff-check
21+
args: [ --exit-non-zero-on-fix ]
22+
- id: ruff-format

0 commit comments

Comments
 (0)