Skip to content

Commit 6b3e06e

Browse files
atxpaulatxpaul
committed
First commit
0 parents  commit 6b3e06e

File tree

14 files changed

+450
-0
lines changed

14 files changed

+450
-0
lines changed

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: setup-python
2+
description: sets up python
3+
4+
inputs:
5+
python-version:
6+
description: 'Python version to set up'
7+
required: false
8+
default: '3.12'
9+
10+
environment:
11+
description: 'Environment for installing dependencies'
12+
required: false
13+
default: 'dev'
14+
15+
runs:
16+
using: composite
17+
steps:
18+
- name: Set up Python ${{ inputs.python-version }}
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: ${{ inputs.python-version }}
22+
23+
- name: Install dependencies (requirements)
24+
if: ${{ inputs.environment == 'prod' }}
25+
run: |
26+
pip install -r requirements.txt
27+
shell: bash
28+
29+
- name: Install dependencies (requirements-dev)
30+
if: ${{ inputs.environment == 'dev' }}
31+
run: |
32+
pip install -r requirements-dev.txt
33+
shell: bash

‎.github/workflows/_docker.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
on:
2+
workflow_call:
3+
4+
jobs:
5+
docker:
6+
if: ${{ github.event_name != 'pull_request' }}
7+
runs-on: ubuntu-22.04
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v4
11+
12+
- name: Login to DockerHub
13+
uses: docker/login-action@v3
14+
with:
15+
username: ${{ secrets.DOCKERHUB_USERNAME }}
16+
password: ${{ secrets.DOCKERHUB_TOKEN }}
17+
18+
- name: Set up Docker Buildx
19+
uses: docker/setup-buildx-action@v3
20+
21+
- name: Load cached Docker layers
22+
uses: actions/cache@v4
23+
with:
24+
path: /tmp/.buildx-cache
25+
key: ${{ runner.os }}-buildx-${{ github.ref }}-${{ hashFiles('Dockerfile') }}
26+
restore-keys: |
27+
${{ runner.os }}-buildx-${{ github.ref }}-
28+
${{ runner.os }}-buildx-
29+
30+
- name: Build and push
31+
uses: docker/build-push-action@v6
32+
with:
33+
context: .
34+
push: true
35+
tags: atxpaul/python-test-pipeline:${{ github.sha }}
36+
cache-from: type=local,src=/tmp/.buildx-cache
37+
cache-to: type=local,dest=/tmp/.buildx-cache,mode=max

‎.github/workflows/_lint.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
on:
2+
workflow_call:
3+
4+
jobs:
5+
lint-code:
6+
runs-on: ubuntu-22.04
7+
steps:
8+
- name: Checkout code
9+
uses: actions/checkout@v4
10+
11+
- name: Setup Python
12+
uses: ./.github/actions/setup-python
13+
with:
14+
python-version: '3.12'
15+
environment: 'dev'
16+
17+
- name: Lint
18+
run: |
19+
ruff check . --output-format=github --target-version=py312

‎.github/workflows/_unittest.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
on:
2+
workflow_call:
3+
4+
jobs:
5+
unittest:
6+
runs-on: ubuntu-22.04
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
issues: write
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4
14+
15+
- name: Setup Python
16+
uses: ./.github/actions/setup-python
17+
with:
18+
python-version: '3.12'
19+
environment: 'dev'
20+
21+
- name: Test with pytest and coverage
22+
run: |
23+
coverage run -m pytest
24+
coverage report -m --omit="test_*" > coverage.txt
25+
coverage html --omit="test_*"
26+
27+
- name: Capture coverage report
28+
id: get_coverage
29+
run: |
30+
echo "coverage<<EOF" >> $GITHUB_OUTPUT
31+
cat coverage.txt >> $GITHUB_OUTPUT
32+
echo "EOF" >> $GITHUB_OUTPUT
33+
34+
- name: Add coverage report to summary
35+
run: |
36+
echo "## Coverage Report" >> $GITHUB_STEP_SUMMARY
37+
echo '```' >> $GITHUB_STEP_SUMMARY
38+
cat coverage.txt >> $GITHUB_STEP_SUMMARY
39+
echo '```' >> $GITHUB_STEP_SUMMARY
40+
41+
- name: Create or update PR comment with coverage report
42+
if: ${{ github.event_name == 'pull_request' }}
43+
uses: peter-evans/create-or-update-comment@v3
44+
with:
45+
token: ${{ secrets.GITHUB_TOKEN }}
46+
issue-number: ${{ github.event.pull_request.number }}
47+
body: |
48+
## Coverage Report
49+
```
50+
${{ steps.get_coverage.outputs.coverage }}
51+
```
52+
53+
- name: Fail if coverage is below threshold
54+
run: |
55+
coverage_result=$(tail -n 1 coverage.txt | awk '{print $NF}' | sed 's/%//')
56+
echo "Coverage: $coverage_result%"
57+
if (( $(echo "$coverage_result < 70" | bc -l) )); then
58+
echo "Coverage is below 70%. Failing the pipeline."
59+
exit 1
60+
fi

‎.github/workflows/build.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Python-App-Pipeline-Example
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Set up version 3.12 python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: 3.12
18+
19+
- name: Install dependencies
20+
run: |
21+
pip install -r requirements-dev.txt
22+
23+
- name: Test with pytest
24+
run: |
25+
pytest
26+
27+
docker:
28+
needs: build
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
33+
- name: Login to Dockerhub
34+
uses: docker/login-action@v3
35+
with:
36+
username: ${{secrets.DOCKERHUB_USERNAME}}
37+
password: ${{secrets.DOCKERHUB_TOKEN}}
38+
39+
- name: Build and push
40+
uses: docker/build-push-action@v6
41+
with:
42+
context: .
43+
push: true
44+
tags: atxpaul/python-app-pipeline-example:${{github.sha}}

‎.github/workflows/main.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Main
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
12+
jobs:
13+
lint:
14+
uses: ./.github/workflows/_lint.yml
15+
secrets: inherit
16+
17+
unittest:
18+
uses: ./.github/workflows/_unittest.yml
19+
secrets: inherit
20+
21+
docker:
22+
uses: ./.github/workflows/_docker.yml
23+
secrets: inherit
24+
needs: [lint, unittest]

‎.gitignore‎

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

0 commit comments

Comments
 (0)