Skip to content

Commit 84ad2db

Browse files
authored
Initial commit
0 parents  commit 84ad2db

File tree

12 files changed

+1053
-0
lines changed

12 files changed

+1053
-0
lines changed

.github/workflows/lint.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Lint
2+
3+
env:
4+
DEFAULT_PYTHON_VERSION: "3.13"
5+
DEFAULT_POETRY_VERSION: "2.1.0"
6+
7+
on:
8+
push:
9+
branches:
10+
- main
11+
pull_request:
12+
types:
13+
- opened
14+
- synchronize
15+
16+
jobs:
17+
lint:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- name: Install Poetry
22+
run: pipx install poetry==${{ env.DEFAULT_POETRY_VERSION }}
23+
- name: Set up Python
24+
uses: actions/setup-python@v5
25+
with:
26+
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
27+
cache: "poetry"
28+
- name: Install dependencies
29+
run: poetry install --with dev
30+
- name: Lint
31+
run: poetry run ruff check .
32+
33+
check-format:
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions/checkout@v4
37+
- name: Install Poetry
38+
run: pipx install poetry==${{ env.DEFAULT_POETRY_VERSION }}
39+
- name: Set up Python
40+
uses: actions/setup-python@v5
41+
with:
42+
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
43+
cache: "poetry"
44+
- name: Install dependencies
45+
run: poetry install --with dev
46+
- name: Lint
47+
run: poetry run ruff format --check .

.github/workflows/test.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Test
2+
3+
env:
4+
DEFAULT_POETRY_VERSION: "2.1.0"
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
pull_request:
11+
types:
12+
- opened
13+
- synchronize
14+
15+
jobs:
16+
test:
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
python-version:
21+
- "3.13"
22+
- "3.12"
23+
- "3.11"
24+
- "3.10"
25+
fail-fast: false
26+
steps:
27+
- uses: actions/checkout@v4
28+
- name: Install Poetry
29+
run: pipx install poetry==${{ env.DEFAULT_POETRY_VERSION }}
30+
- name: Set up Python
31+
uses: actions/setup-python@v5
32+
with:
33+
python-version: ${{ matrix.python-version }}
34+
cache: "poetry"
35+
- name: Install dependencies
36+
run: poetry install --with dev
37+
- name: Test
38+
run: poetry run pytest -vra

.gitignore

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
### VisualStudioCode template
2+
.vscode/*
3+
!.vscode/settings.json
4+
!.vscode/tasks.json
5+
!.vscode/launch.json
6+
!.vscode/extensions.json
7+
!.vscode/*.code-snippets
8+
9+
# Local History for Visual Studio Code
10+
.history/
11+
12+
# Built Visual Studio Code Extensions
13+
*.vsix
14+
15+
### JetBrains template
16+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
17+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
18+
19+
# User-specific stuff
20+
.idea/**/workspace.xml
21+
.idea/**/tasks.xml
22+
.idea/**/usage.statistics.xml
23+
.idea/**/dictionaries
24+
.idea/**/shelf
25+
26+
# AWS User-specific
27+
.idea/**/aws.xml
28+
29+
# Generated files
30+
.idea/**/contentModel.xml
31+
32+
# Sensitive or high-churn files
33+
.idea/**/dataSources/
34+
.idea/**/dataSources.ids
35+
.idea/**/dataSources.local.xml
36+
.idea/**/sqlDataSources.xml
37+
.idea/**/dynamic.xml
38+
.idea/**/uiDesigner.xml
39+
.idea/**/dbnavigator.xml
40+
41+
# Gradle
42+
.idea/**/gradle.xml
43+
.idea/**/libraries
44+
45+
# Gradle and Maven with auto-import
46+
# When using Gradle or Maven with auto-import, you should exclude module files,
47+
# since they will be recreated, and may cause churn. Uncomment if using
48+
# auto-import.
49+
# .idea/artifacts
50+
# .idea/compiler.xml
51+
# .idea/jarRepositories.xml
52+
# .idea/modules.xml
53+
# .idea/*.iml
54+
# .idea/modules
55+
# *.iml
56+
# *.ipr
57+
58+
# CMake
59+
cmake-build-*/
60+
61+
# Mongo Explorer plugin
62+
.idea/**/mongoSettings.xml
63+
64+
# File-based project format
65+
*.iws
66+
67+
# IntelliJ
68+
out/
69+
70+
# mpeltonen/sbt-idea plugin
71+
.idea_modules/
72+
73+
# JIRA plugin
74+
atlassian-ide-plugin.xml
75+
76+
# Cursive Clojure plugin
77+
.idea/replstate.xml
78+
79+
# SonarLint plugin
80+
.idea/sonarlint/
81+
82+
# Crashlytics plugin (for Android Studio and IntelliJ)
83+
com_crashlytics_export_strings.xml
84+
crashlytics.properties
85+
crashlytics-build.properties
86+
fabric.properties
87+
88+
# Editor-based Rest Client
89+
.idea/httpRequests
90+
91+
# Android studio 3.1+ serialized cache file
92+
.idea/caches/build_file_checksums.ser
93+
94+
### VirtualEnv template
95+
# Virtualenv
96+
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
97+
.Python
98+
[Bb]in
99+
[Ii]nclude
100+
[Ll]ib
101+
[Ll]ib64
102+
[Ll]ocal
103+
[Ss]cripts
104+
pyvenv.cfg
105+
.venv
106+
pip-selfcheck.json
107+
108+
### Python template
109+
# Byte-compiled / optimized / DLL files
110+
__pycache__/
111+
*.py[cod]
112+
*$py.class
113+
114+
# C extensions
115+
*.so
116+
117+
# Distribution / packaging
118+
build/
119+
develop-eggs/
120+
dist/
121+
downloads/
122+
eggs/
123+
.eggs/
124+
lib/
125+
lib64/
126+
parts/
127+
sdist/
128+
var/
129+
wheels/
130+
share/python-wheels/
131+
*.egg-info/
132+
.installed.cfg
133+
*.egg
134+
MANIFEST
135+
136+
# PyInstaller
137+
# Usually these files are written by a python script from a template
138+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
139+
*.manifest
140+
*.spec
141+
142+
# Installer logs
143+
pip-log.txt
144+
pip-delete-this-directory.txt
145+
146+
# Unit test / coverage reports
147+
htmlcov/
148+
.tox/
149+
.nox/
150+
.coverage
151+
.coverage.*
152+
.cache
153+
nosetests.xml
154+
coverage.xml
155+
*.cover
156+
*.py,cover
157+
.hypothesis/
158+
.pytest_cache/
159+
cover/
160+
161+
# Translations
162+
*.mo
163+
*.pot
164+
165+
# Django stuff:
166+
*.log
167+
local_settings.py
168+
db.sqlite3
169+
db.sqlite3-journal
170+
171+
# Flask stuff:
172+
instance/
173+
.webassets-cache
174+
175+
# Scrapy stuff:
176+
.scrapy
177+
178+
# Sphinx documentation
179+
docs/_build/
180+
181+
# PyBuilder
182+
.pybuilder/
183+
target/
184+
185+
# Jupyter Notebook
186+
.ipynb_checkpoints
187+
188+
# IPython
189+
profile_default/
190+
ipython_config.py
191+
192+
# pyenv
193+
# For a library or package, you might want to ignore these files since the code is
194+
# intended to run in multiple environments; otherwise, check them in:
195+
# .python-version
196+
197+
# pipenv
198+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
199+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
200+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
201+
# install all needed dependencies.
202+
#Pipfile.lock
203+
204+
# poetry
205+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
206+
# This is especially recommended for binary packages to ensure reproducibility, and is more
207+
# commonly ignored for libraries.
208+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
209+
#poetry.lock
210+
211+
# pdm
212+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
213+
#pdm.lock
214+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
215+
# in version control.
216+
# https://pdm.fming.dev/#use-with-ide
217+
.pdm.toml
218+
219+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
220+
__pypackages__/
221+
222+
# Celery stuff
223+
celerybeat-schedule
224+
celerybeat.pid
225+
226+
# SageMath parsed files
227+
*.sage.py
228+
229+
# Environments
230+
.env
231+
env/
232+
venv/
233+
ENV/
234+
env.bak/
235+
venv.bak/
236+
237+
# Spyder project settings
238+
.spyderproject
239+
.spyproject
240+
241+
# Rope project settings
242+
.ropeproject
243+
244+
# mkdocs documentation
245+
/site
246+
247+
# mypy
248+
.mypy_cache/
249+
.dmypy.json
250+
dmypy.json
251+
252+
# Pyre type checker
253+
.pyre/
254+
255+
# pytype static type analyzer
256+
.pytype/
257+
258+
# Cython debug symbols
259+
cython_debug/
260+
261+
# PyCharm
262+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
263+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
264+
# and can be added to the global gitignore or merged into this file. For a more nuclear
265+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
266+
.idea/

.pre-commit-config.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v5.0.0
6+
hooks:
7+
- id: check-added-large-files
8+
- id: check-toml
9+
- id: check-yaml
10+
args: [ --unsafe ]
11+
- id: end-of-file-fixer
12+
- id: trailing-whitespace
13+
args: [ --markdown-linebreak-ext=md ]
14+
- repo: https://github.com/astral-sh/ruff-pre-commit
15+
rev: v0.9.6
16+
hooks:
17+
- id: ruff
18+
args: [ --fix ]
19+
- id: ruff-format
20+
- repo: https://github.com/compilerla/conventional-pre-commit
21+
rev: v4.0.0
22+
hooks:
23+
- id: conventional-pre-commit
24+
stages: [ commit-msg ]
25+
args: [ ]

0 commit comments

Comments
 (0)