Skip to content

Commit fe736f7

Browse files
chriswblakechriswblake
authored
feat: setup dev environment, add topics and topic lists (#1)
1 parent 2a8d2ba commit fe736f7

17 files changed

Lines changed: 1509 additions & 1 deletion

‎.devcontainer/devcontainer.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "Python 3",
3+
"image": "mcr.microsoft.com/devcontainers/base:jammy",
4+
"features": {
5+
"ghcr.io/devcontainers/features/python:1": {
6+
"version": "3.10"
7+
},
8+
"ghcr.io/dhoeric/features/act:1": {},
9+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}, // Use this if running locally as a Dev Container
10+
// "ghcr.io/devcontainers/features/docker-in-docker:2": {}, // Use this if running as a Codespace
11+
"ghcr.io/devcontainers/features/github-cli:1": {}
12+
},
13+
"customizations": {
14+
"vscode": {
15+
"extensions": [
16+
"ms-python.python",
17+
"ms-python.debugpy",
18+
"esbenp.prettier-vscode"
19+
],
20+
"settings": {
21+
"editor.formatOnSave": true,
22+
"editor.defaultFormatter": "esbenp.prettier-vscode",
23+
}
24+
}
25+
},
26+
"postCreateCommand": "postCreate.sh"
27+
}

‎.devcontainer/postCreate.sh‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Install project dependencies
2+
python -m pip install --upgrade pip
3+
pip install -r requirements.txt
4+
pip install -r requirements-dev.txt

‎.github/workflows/unit-tests.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Unit Tests
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
jobs:
9+
verify_unit_tests:
10+
runs-on: ubuntu-latest
11+
strategy:
12+
matrix:
13+
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
14+
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install -r requirements.txt
27+
pip install -r requirements-dev.txt
28+
29+
- name: Run tests with pytest
30+
run: |
31+
pytest

‎.gitignore‎

Lines changed: 302 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,302 @@
1+
###
2+
### Python - https://github.com/github/gitignore/blob/main/Python.gitignore
3+
###
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+
# Redis
139+
*.rdb
140+
*.aof
141+
*.pid
142+
143+
# RabbitMQ
144+
mnesia/
145+
rabbitmq/
146+
rabbitmq-data/
147+
148+
# ActiveMQ
149+
activemq-data/
150+
151+
# SageMath parsed files
152+
*.sage.py
153+
154+
# Environments
155+
.env
156+
.envrc
157+
.venv
158+
env/
159+
venv/
160+
ENV/
161+
env.bak/
162+
venv.bak/
163+
164+
# Spyder project settings
165+
.spyderproject
166+
.spyproject
167+
168+
# Rope project settings
169+
.ropeproject
170+
171+
# mkdocs documentation
172+
/site
173+
174+
# mypy
175+
.mypy_cache/
176+
.dmypy.json
177+
dmypy.json
178+
179+
# Pyre type checker
180+
.pyre/
181+
182+
# pytype static type analyzer
183+
.pytype/
184+
185+
# Cython debug symbols
186+
cython_debug/
187+
188+
# PyCharm
189+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
190+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
191+
# and can be added to the global gitignore or merged into this file. For a more nuclear
192+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
193+
# .idea/
194+
195+
# Abstra
196+
# Abstra is an AI-powered process automation framework.
197+
# Ignore directories containing user credentials, local state, and settings.
198+
# Learn more at https://abstra.io/docs
199+
.abstra/
200+
201+
# Visual Studio Code
202+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
203+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
204+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
205+
# you could uncomment the following to ignore the entire vscode folder
206+
# .vscode/
207+
208+
# Ruff stuff:
209+
.ruff_cache/
210+
211+
# PyPI configuration file
212+
.pypirc
213+
214+
# Marimo
215+
marimo/_static/
216+
marimo/_lsp/
217+
__marimo__/
218+
219+
# Streamlit
220+
.streamlit/secrets.toml
221+
222+
223+
###
224+
### Linux - https://github.com/github/gitignore/blob/main/Global/Linux.gitignore
225+
###
226+
227+
*~
228+
229+
# temporary files which can be created if a process still has a handle open of a deleted file
230+
.fuse_hidden*
231+
232+
# Metadata left by Dolphin file manager, which comes with KDE Plasma
233+
.directory
234+
235+
# Linux trash folder which might appear on any partition or disk
236+
.Trash-*
237+
238+
# .nfs files are created when an open file is removed but is still being accessed
239+
.nfs*
240+
241+
# Log files created by default by the nohup command
242+
nohup.out
243+
244+
###
245+
### macOS - https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
246+
###
247+
248+
# General
249+
.DS_Store
250+
__MACOSX/
251+
.AppleDouble
252+
.LSOverride
253+
Icon[
254+
]
255+
256+
# Thumbnails
257+
._*
258+
259+
# Files that might appear in the root of a volume
260+
.DocumentRevisions-V100
261+
.fseventsd
262+
.Spotlight-V100
263+
.TemporaryItems
264+
.Trashes
265+
.VolumeIcon.icns
266+
.com.apple.timemachine.donotpresent
267+
268+
# Directories potentially created on remote AFP share
269+
.AppleDB
270+
.AppleDesktop
271+
Network Trash Folder
272+
Temporary Items
273+
.apdisk
274+
275+
###
276+
### Windows - https://github.com/github/gitignore/blob/main/Global/Windows.gitignore
277+
###
278+
279+
# Windows thumbnail cache files
280+
Thumbs.db
281+
Thumbs.db:encryptable
282+
ehthumbs.db
283+
ehthumbs_vista.db
284+
285+
# Dump file
286+
*.stackdump
287+
288+
# Folder config file
289+
[Dd]esktop.ini
290+
291+
# Recycle Bin used on file shares
292+
$RECYCLE.BIN/
293+
294+
# Windows Installer files
295+
*.cab
296+
*.msi
297+
*.msix
298+
*.msm
299+
*.msp
300+
301+
# Windows shortcuts
302+
*.lnk

‎.vscode/settings.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
// Python
3+
"python.analysis.typeCheckingMode": "standard",
4+
"python.testing.pytestEnabled": true,
5+
"python.testing.unittestEnabled": false,
6+
"python.testing.pytestArgs": [
7+
"tests"
8+
],
9+
10+
// VS Code
11+
"files.exclude": {
12+
"*.pytest_cache": true,
13+
"*.egg-info": true,
14+
}
15+
}

0 commit comments

Comments
 (0)