Skip to content

Commit 36d1dec

Browse files
nullhacknullhack
committed
Publish API documentation
1 parent 73cace3 commit 36d1dec

File tree

42 files changed

+7549
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+7549
-0
lines changed

‎python-project-template/.github/workflows/check-code.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
name: Check Code standards
3+
4+
on:
5+
push:
6+
7+
jobs:
8+
set-up-docker:
9+
runs-on: ubuntu-latest
10+
steps:
11+
-
12+
name: Checkout
13+
uses: actions/checkout@v4
14+
-
15+
name: Install ruff
16+
run: |
17+
python -m pip install --upgrade pip
18+
pip install ruff
19+
-
20+
name: run ruff
21+
run: |
22+
ruff check **/*.py
23+
-
24+
name: run ruff format
25+
run: |
26+
ruff format **/*.py
27+

‎python-project-template/.github/workflows/release-docker-image.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
name: Release Docker Image CI/CD
3+
4+
on:
5+
release:
6+
types:
7+
- published
8+
- edited
9+
10+
jobs:
11+
set-up-docker:
12+
runs-on: ubuntu-latest
13+
steps:
14+
-
15+
name: Checkout
16+
uses: actions/checkout@v4
17+
-
18+
name: Install docker
19+
run: apt update && apt install -y docker-compose
20+
-
21+
name: Login to Docker registry
22+
uses: docker/login-action@v3
23+
with:
24+
registry: ${{ vars.DOCKER_REGISTRY_URL }}
25+
username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
26+
password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
27+
-
28+
name: Set up Docker Buildx
29+
uses: docker/setup-buildx-action@v3
30+
-
31+
name: Build and push release tag
32+
uses: docker/build-push-action@v5
33+
with:
34+
context: .
35+
push: true
36+
tags: ${{ vars.DOCKER_REGISTRY_URL }}/${{ github.event.repository.name }}:${{ github.ref_name }}
37+
-
38+
name: Build and push latest
39+
uses: docker/build-push-action@v5
40+
with:
41+
context: .
42+
push: true
43+
tags: ${{ vars.DOCKER_REGISTRY_URL }}/${{ github.event.repository.name }}:latest
44+
45+

‎python-project-template/.github/workflows/test-docker-image.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
name: Test Docker Image CI/CD
3+
4+
on:
5+
pull_request:
6+
7+
jobs:
8+
set-up-docker:
9+
runs-on: ubuntu-latest
10+
steps:
11+
-
12+
name: Checkout
13+
uses: actions/checkout@v4
14+
-
15+
name: Install docker
16+
run: apt update && apt install -y docker-compose
17+
-
18+
name: Set up Docker Buildx
19+
uses: docker/setup-buildx-action@v3
20+
-
21+
name: Build and test
22+
uses: docker/build-push-action@v5
23+
with:
24+
context: .
25+
file: ./Dockerfile
26+
push: false
27+

‎python-project-template/.gitignore‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
.DS_Store
2+
.coverage
3+
.vscode/\n.idea/
4+
# Byte-compiled / optimized / DLL files
5+
__pycache__/
6+
*.py[cod]
7+
*$py.class
8+
9+
# Remove html generated by documentation
10+
11+
docs/html
12+
13+
# Remove tests and coverage reports
14+
docs/cov-report
15+
docs/pytest_report.html
16+
17+
# C extensions
18+
*.so
19+
20+
# Distribution / packaging
21+
.Python
22+
build/
23+
develop-eggs/
24+
dist/
25+
downloads/
26+
eggs/
27+
.eggs/
28+
lib/
29+
lib64/
30+
parts/
31+
sdist/
32+
var/
33+
wheels/
34+
share/python-wheels/
35+
*.egg-info/
36+
.installed.cfg
37+
*.egg
38+
MANIFEST
39+
40+
# PyInstaller
41+
# Usually these files are written by a python script from a template
42+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
43+
*.manifest
44+
*.spec
45+
46+
# Installer logs
47+
pip-log.txt
48+
pip-delete-this-directory.txt
49+
50+
# Unit test / coverage reports
51+
htmlcov/
52+
.tox/
53+
.nox/
54+
.coverage
55+
.coverage.*
56+
.cache
57+
nosetests.xml
58+
coverage.xml
59+
*.cover
60+
*.py,cover
61+
.hypothesis/
62+
.pytest_cache/
63+
cover/
64+
65+
# Translations
66+
*.mo
67+
*.pot
68+
69+
# Django stuff:
70+
*.log
71+
local_settings.py
72+
db.sqlite3
73+
db.sqlite3-journal
74+
75+
# Flask stuff:
76+
instance/
77+
.webassets-cache
78+
79+
# Scrapy stuff:
80+
.scrapy
81+
82+
# Sphinx documentation
83+
docs/_build/
84+
85+
# PyBuilder
86+
.pybuilder/
87+
target/
88+
89+
# Jupyter Notebook
90+
.ipynb_checkpoints
91+
92+
# IPython
93+
profile_default/
94+
ipython_config.py
95+
96+
# pyenv
97+
# For a library or package, you might want to ignore these files since the code is
98+
# intended to run in multiple environments; otherwise, check them in:
99+
# .python-version
100+
101+
# pipenv
102+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
103+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
104+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
105+
# install all needed dependencies.
106+
#Pipfile.lock
107+
108+
# poetry
109+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
110+
# This is especially recommended for binary packages to ensure reproducibility, and is more
111+
# commonly ignored for libraries.
112+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
113+
#poetry.lock
114+
115+
# pdm
116+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117+
#pdm.lock
118+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
119+
# in version control.
120+
# https://pdm.fming.dev/#use-with-ide
121+
.pdm.toml
122+
123+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
124+
__pypackages__/
125+
126+
# Celery stuff
127+
celerybeat-schedule
128+
celerybeat.pid
129+
130+
# SageMath parsed files
131+
*.sage.py
132+
133+
# Environments
134+
.env
135+
.venv
136+
env/
137+
venv/
138+
ENV/
139+
env.bak/
140+
venv.bak/
141+
142+
# Spyder project settings
143+
.spyderproject
144+
.spyproject
145+
146+
# Rope project settings
147+
.ropeproject
148+
149+
# mkdocs documentation
150+
/site
151+
152+
# mypy
153+
.mypy_cache/
154+
.dmypy.json
155+
dmypy.json
156+
157+
# Pyre type checker
158+
.pyre/
159+
160+
# pytype static type analyzer
161+
.pytype/
162+
163+
# Cython debug symbols
164+
cython_debug/
165+
166+
# PyCharm
167+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
168+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
169+
# and can be added to the global gitignore or merged into this file. For a more nuclear
170+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
171+
#.idea/

0 commit comments

Comments
 (0)