Skip to content
This repository was archived by the owner on Jun 25, 2026. It is now read-only.

Commit 9b29081

Browse files
committed
merge: resolve conflicts with main, keep api service in compose files
2 parents ce2f9ca + 50234fa commit 9b29081

18 files changed

Lines changed: 1268 additions & 11 deletions

Justfile

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
default:
22
just --list
33

4-
# ENV = {doc}
4+
# ENV = {doc | dev | prod}
55
up ENV:
66
#!/bin/bash
77
if [ "{{ENV}}" = "doc" ]; then
8-
docker compose -f docker/{{ENV}}/compose.yml up --detach
8+
docker compose -f documentation/compose.yml up --detach
9+
elif [ "{{ENV}}" = "dev" ]; then
10+
docker compose -f compose.dev.yml up --detach --build
11+
elif [ "{{ENV}}" = "prod" ]; then
12+
docker compose -f compose.prod.yml up --detach --build
913
else
10-
echo "{{ENV}}: Accepted values are: 'doc'." >&2
14+
echo "{{ENV}}: Accepted values are: 'doc|dev|prod'." >&2
1115
fi
1216

13-
# ENV = {doc}
17+
# ENV = {doc | dev | prod}
1418
down ENV:
1519
#!/bin/bash
1620
if [ "{{ENV}}" = "doc" ]; then
17-
docker compose -f docker/{{ENV}}/compose.yml down
21+
docker compose -f documentation/compose.yml down --volumes
22+
elif [ "{{ENV}}" = "dev" ]; then
23+
docker compose -f compose.dev.yml down
24+
elif [ "{{ENV}}" = "prod" ]; then
25+
docker compose -f compose.prod.yml down
1826
else
19-
echo "{{ENV}}: Accepted values are: 'doc'." >&2
27+
echo "{{ENV}}: Accepted values are: 'doc|dev|prod'." >&2
2028
fi
2129

22-
# ENV = {doc}
30+
# ENV = {doc | dev | prod}
2331
logs ENV:
2432
#!/bin/bash
2533
if [ "{{ENV}}" = "doc" ]; then
26-
docker compose -f docker/{{ENV}}/compose.yml logs --follow
34+
docker compose -f documentation/compose.yml logs --follow
35+
elif [ "{{ENV}}" = "dev" ]; then
36+
docker compose -f compose.dev.yml logs --follow
37+
elif [ "{{ENV}}" = "prod" ]; then
38+
docker compose -f compose.prod.yml logs --follow
2739
else
28-
echo "{{ENV}}: Accepted values are: 'doc'." >&2
40+
echo "{{ENV}}: Accepted values are: 'doc|dev|prod'." >&2
2941
fi
42+
43+
shell ENV:
44+
docker compose -f compose.{{ENV}}.yml exec -it api sh

api/.gitignore

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
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+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
#poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
#pdm.lock
116+
#pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
#pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# SageMath parsed files
135+
*.sage.py
136+
137+
# Environments
138+
.env
139+
.envrc
140+
.venv
141+
env/
142+
venv/
143+
ENV/
144+
env.bak/
145+
venv.bak/
146+
147+
# Spyder project settings
148+
.spyderproject
149+
.spyproject
150+
151+
# Rope project settings
152+
.ropeproject
153+
154+
# mkdocs documentation
155+
/site
156+
157+
# mypy
158+
.mypy_cache/
159+
.dmypy.json
160+
dmypy.json
161+
162+
# Pyre type checker
163+
.pyre/
164+
165+
# pytype static type analyzer
166+
.pytype/
167+
168+
# Cython debug symbols
169+
cython_debug/
170+
171+
# PyCharm
172+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174+
# and can be added to the global gitignore or merged into this file. For a more nuclear
175+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176+
#.idea/
177+
178+
# Abstra
179+
# Abstra is an AI-powered process automation framework.
180+
# Ignore directories containing user credentials, local state, and settings.
181+
# Learn more at https://abstra.io/docs
182+
.abstra/
183+
184+
# Visual Studio Code
185+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
188+
# you could uncomment the following to ignore the entire vscode folder
189+
# .vscode/
190+
191+
# Ruff stuff:
192+
.ruff_cache/
193+
194+
# PyPI configuration file
195+
.pypirc
196+
197+
# Cursor
198+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200+
# refer to https://docs.cursor.com/context/ignore-files
201+
.cursorignore
202+
.cursorindexingignore
203+
204+
# Marimo
205+
marimo/_static/
206+
marimo/_lsp/
207+
__marimo__/
208+
.idea/**

api/.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.13

api/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Homepedia API

api/docker/dev/Dockerfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM python:3.13-slim
2+
3+
# Installer uv
4+
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
5+
6+
WORKDIR /app
7+
8+
# Installer les dépendances en premier pour tirer parti du cache Docker
9+
COPY pyproject.toml uv.lock ./
10+
RUN uv sync --frozen --no-install-project
11+
12+
# Le code source est monté via bind mount en dev
13+
EXPOSE 8000
14+
15+
CMD ["uv", "run", "fastapi", "dev", "main.py", "--host", "0.0.0.0", "--port", "8000"]

api/docker/prod/Dockerfile

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# ─── Stage 1 : Build ────────────────────────────────────────────────────────
2+
FROM python:3.13-slim AS builder
3+
4+
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
5+
6+
WORKDIR /app
7+
8+
COPY pyproject.toml uv.lock ./
9+
RUN uv sync --frozen --no-install-project --no-dev
10+
11+
COPY . .
12+
RUN uv sync --frozen --no-dev
13+
14+
# ─── Stage 2 : Run ───────────────────────────────────────────────────────────
15+
FROM python:3.13-slim
16+
17+
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
18+
19+
WORKDIR /app
20+
21+
COPY --from=builder /app /app
22+
23+
EXPOSE 8000
24+
25+
CMD ["uv", "run", "fastapi", "run", "main.py", "--host", "0.0.0.0", "--port", "8000"]

api/main.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
from fastapi import FastAPI
2+
3+
app = FastAPI()
4+
5+
6+
@app.get("/")
7+
def read_root():
8+
return {"Hello": "World"}

api/pyproject.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[project]
2+
name = "homepedia-api"
3+
version = "0.1.0"
4+
description = "REST API for the Homepedia data"
5+
readme = "README.md"
6+
requires-python = ">=3.13"
7+
dependencies = [
8+
"fastapi[standard]>=0.135.1",
9+
]

0 commit comments

Comments
 (0)