Skip to content

Commit a75b98d

Browse files
DigiFenix777DigiFenix777
authored
Merge pull request #6 from DigiFenix777/pre-publication-polish
Prep Working With APIs Project for publication
2 parents 96d23ba + 30fe3a5 commit a75b98d

File tree

7 files changed

+433
-20
lines changed

7 files changed

+433
-20
lines changed

‎.gitattributes‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# ------------------------------------------------------------
2+
# Core: normalize line endings and treat text sensibly
3+
# ------------------------------------------------------------
4+
* text=auto # Let Git detect text/binary; normalize line endings
5+
*.sh text eol=lf # Shell scripts should use LF
6+
*.py text eol=lf
7+
*.pyw text eol=lf
8+
*.toml text eol=lf
9+
*.yml text eol=lf
10+
*.yaml text eol=lf
11+
*.md text eol=lf
12+
*.json text eol=lf
13+
*.csv text eol=lf
14+
*.ini text eol=lf
15+
*.cfg text eol=lf
16+
*.env text eol=lf
17+
*.bat text eol=crlf # Windows batch files typically CRLF
18+
19+
# ------------------------------------------------------------
20+
# Binary / no-diff files (avoid noisy diffs)
21+
# ------------------------------------------------------------
22+
*.png binary
23+
*.jpg binary
24+
*.jpeg binary
25+
*.gif binary
26+
*.svg text eol=lf # SVGs are XML (text); keep LF but allow diffs
27+
*.pdf binary
28+
*.zip binary
29+
*.gz binary
30+
*.bz2 binary
31+
*.7z binary
32+
*.pkl binary
33+
*.db binary
34+
*.sqlite binary
35+
*.sqlite3 binary
36+
37+
# Jupyter notebooks can create massive, noisy diffs.
38+
# If you prefer *no* diffs in PRs, uncomment the next line:
39+
# *.ipynb -diff
40+
41+
# ------------------------------------------------------------
42+
# GitHub Linguist (repo language stats and file classification)
43+
# ------------------------------------------------------------
44+
45+
# Treat vendored/third-party code as vendored so it doesn’t skew language stats
46+
vendor/** linguist-vendored
47+
third_party/** linguist-vendored
48+
49+
# Treat generated artifacts as generated
50+
dist/** linguist-generated
51+
build/** linguist-generated
52+
html/** linguist-generated
53+
images/** linguist-generated
54+
55+
# Keep documentation from skewing language stats
56+
docs/** linguist-documentation
57+
*.md linguist-documentation
58+
59+
# If you keep datasets in-repo, mark them as vendored or data (not source)
60+
data/** linguist-vendored
61+
62+
# ------------------------------------------------------------
63+
# Optional: merge strategies for “lock”/machine files
64+
# (Uncomment if you use Poetry/Pipenv and prefer taking incoming on conflicts)
65+
# ------------------------------------------------------------
66+
# poetry.lock merge=union
67+
# Pipfile.lock merge=union
68+
69+
# ------------------------------------------------------------
70+
# Optional: export-ignore for archives (keeps source bundles lean)
71+
# Uncomment to exclude dev-only files from `git archive`
72+
# ------------------------------------------------------------
73+
# .gitattributes export-ignore
74+
# .gitignore export-ignore
75+
# .github/ export-ignore
76+
# tests/ export-ignore

‎.gitignore‎

Lines changed: 155 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,164 @@
1+
# --------------------------------------
12
# Python
3+
# --------------------------------------
24
__pycache__/
35
*.py[cod]
4-
*.egg-info/
5-
.eggs/
6-
dist/
7-
build/
6+
*$py.class
7+
8+
# Virtual environments
89
.venv/
910
venv/
10-
.env
11-
.env.*
12-
.pytest_cache/
13-
.mypy_cache/
11+
ENV/
12+
env/
13+
*.env
14+
15+
# Jupyter Notebook checkpoints
16+
.ipynb_checkpoints
17+
18+
# Compiled C extensions
19+
*.so
20+
21+
# Distribution / packaging
22+
.Python
23+
build/
24+
develop-eggs/
25+
dist/
26+
downloads/
27+
eggs/
28+
.eggs/
29+
lib/
30+
lib64/
31+
parts/
32+
sdist/
33+
var/
34+
*.egg-info/
35+
.installed.cfg
36+
*.egg
37+
38+
# Installer logs
39+
pip-log.txt
40+
pip-delete-this-directory.txt
41+
42+
# Unit test / coverage reports
43+
htmlcov/
44+
.tox/
45+
.nox/
1446
.coverage
47+
.coverage.*
48+
.cache
49+
nosetests.xml
1550
coverage.xml
16-
data/
17-
.idea
18-
Python
51+
*.cover
52+
*.py,cover
53+
.hypothesis/
54+
.pytest_cache/
55+
pytestdebug.log
1956

20-
# OS / tools
21-
.DS_Store
57+
# Profiling data
58+
*.prof
59+
*.pstats
60+
*.log
61+
62+
# Django stuff (if applicable)
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff (if applicable)
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
doc/_build/
78+
79+
# PyBuilder
80+
target/
81+
82+
# Jupyter Notebook
83+
.ipynb_checkpoints
84+
85+
# MyPy
86+
.mypy_cache/
87+
.dmypy.json
88+
dmypy.json
89+
90+
# Pyre type checker
91+
.pyre/
92+
93+
# pytype
94+
.pytype/
95+
96+
# Cython debug symbols
97+
cython_debug/
98+
99+
# --------------------------------------
100+
# IDEs & Editors
101+
# --------------------------------------
102+
# PyCharm
22103
.idea/
23-
.ipynb_checkpoints/
104+
*.iml
105+
106+
# VS Code
107+
.vscode/
108+
*.code-workspace
109+
110+
# Other IDEs
111+
*.swp
112+
*.swo
113+
114+
# --------------------------------------
115+
# OS-specific files
116+
# --------------------------------------
117+
# macOS
118+
.DS_Store
119+
.AppleDouble
120+
.LSOverride
121+
Icon?
122+
._*
123+
124+
# Windows
125+
Thumbs.db
126+
ehthumbs.db
127+
Desktop.ini
128+
$RECYCLE.BIN/
129+
130+
# Linux
131+
*~
132+
.nfs*
133+
134+
# --------------------------------------
135+
# Project-specific
136+
# --------------------------------------
137+
# Logs
138+
*.log
139+
logs/
140+
log/
141+
142+
# Data
143+
data/*.csv
144+
data/*.json
145+
data/*.xml
146+
!data/README.md # keep dataset notes
147+
148+
# Images / Outputs
149+
images/*.png
150+
images/*.jpg
151+
images/*.jpeg
152+
images/*.gif
153+
images/*.svg
154+
!images/README.md
155+
156+
# HTML (generated reports)
157+
html/*.html
158+
!html/README.md
159+
160+
# Notebooks (if you want to exclude outputs)
161+
*.ipynb
162+
163+
# Excepting /images/portfolio directory
164+
!/images/portfolio/*

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 DigiFenix777
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)