🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 2 commits into from
Feb 25, 2024
Merged

🚚 Refactor and simplify backend file structure #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e998baf
🚚 Refactor and simplify backend file structure
tiangolo Feb 25, 2024
2ae7c5f
🔥 Remove references to Jupyter inside of Docker, as it's better to ru…
tiangolo Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/backend/.dockerignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv
0 src/backend/app/.flake8 → src/backend/.flake8
View file
Open in desktop
File renamed without changes.
3 changes: 3 additions & 0 deletions src/backend/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
2 changes: 1 addition & 1 deletion src/backend/app/alembic.ini → src/backend/alembic.ini
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down
3 changes: 0 additions & 3 deletions src/backend/app/.gitignore
View file
Open in desktop

This file was deleted.

0 src/backend/app/app/__init__.py → src/backend/app/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py
View file
Open in desktop
File renamed without changes.
0 .../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py
View file
Open in desktop
File renamed without changes.
0 ...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py
View file
Open in desktop
File renamed without changes.
0 ...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py
View file
Open in desktop
File renamed without changes.
0 ...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py
View file
Open in desktop
File renamed without changes.
0 ...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/api/deps.py → src/backend/app/api/deps.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py
View file
Open in desktop
File renamed without changes.
0 ...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/core/config.py → src/backend/app/core/config.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/core/security.py → src/backend/app/core/security.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/crud/base.py → src/backend/app/crud/base.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/db/engine.py → src/backend/app/db/engine.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py
View file
Open in desktop
File renamed without changes.
0 ...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html
View file
Open in desktop
File renamed without changes.
0 ...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html
View file
Open in desktop
File renamed without changes.
0 ...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html
View file
Open in desktop
File renamed without changes.
0 .../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml
View file
Open in desktop
File renamed without changes.
0 ...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml
View file
Open in desktop
File renamed without changes.
0 ...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/initial_data.py → src/backend/app/initial_data.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/main.py → src/backend/app/main.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/models.py → src/backend/app/models.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py
View file
Open in desktop
File renamed without changes.
0 ...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py
View file
Open in desktop
File renamed without changes.
0 ...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py
View file
Open in desktop
File renamed without changes.
0 ...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py
View file
Open in desktop
File renamed without changes.
0 ...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py
View file
Open in desktop
File renamed without changes.
0 ...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/utils.py → src/backend/app/utils.py
View file
Open in desktop
File renamed without changes.
0 src/backend/app/app/worker.py → src/backend/app/worker.py
View file
Open in desktop
File renamed without changes.
17 changes: 9 additions & 8 deletions src/backend/backend.dockerfile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app
17 changes: 6 additions & 11 deletions src/backend/celeryworker.dockerfile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down
0 src/backend/app/mypy.ini → src/backend/mypy.ini
View file
Open in desktop
File renamed without changes.
0 src/backend/app/prestart.sh → src/backend/prestart.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/pyproject.toml → src/backend/pyproject.toml
View file
Open in desktop
File renamed without changes.
0 src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/scripts/format.sh → src/backend/scripts/format.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/scripts/test.sh → src/backend/scripts/test.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/tests-start.sh → src/backend/tests-start.sh
View file
Open in desktop
File renamed without changes.
0 src/backend/app/worker-start.sh → src/backend/worker-start.sh
View file
Open in desktop
File renamed without changes.
8 changes: 2 additions & 6 deletions src/docker-compose.override.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
ports:
- "8888:8888"
volumes:
- ./backend/app:/app
- ./backend/:/app
environment:
- JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
- SERVER_HOST=http://${DOMAIN?Variable not set}
build:
context: ./backend
dockerfile: backend.dockerfile
args:
INSTALL_DEV: ${INSTALL_DEV-true}
INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
# command: sleep infinity # Infinite loop to keep container alive doing nothing
command: /start-reload.sh

celeryworker:
volumes:
- ./backend/app:/app
- ./backend/:/app
environment:
- RUN=celery worker -A app.worker -l info -Q main-queue -c 1
- JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
- SERVER_HOST=http://${DOMAIN?Variable not set}
build:
context: ./backend
dockerfile: celeryworker.dockerfile
args:
INSTALL_DEV: ${INSTALL_DEV-true}
INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

frontend:
build:
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
🚚 Refactor and simplify backend file structure#609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Feb 25, 2024
 Merged


🚚 Refactor and simplify backend file structure
#609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e998baf

🚚 Refactor and simplify backend file structure


tiangolo Feb 25, 2024
2ae7c5f

🔥 Remove references to Jupyter inside of Docker, as it's better to ru…


tiangolo Feb 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/backend/.dockerignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
# Python
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov
.venv

0
src/backend/app/.flake8 → src/backend/.flake8

View file


Open in desktop


File renamed without changes.


3 changes: 3 additions & 0 deletions
src/backend/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
__pycache__
app.egg-info
*.pyc
.mypy_cache
.coverage
htmlcov

2 changes: 1 addition & 1 deletion
src/backend/app/alembic.ini → src/backend/alembic.ini

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[alembic]
# path to migration scripts
script_location = alembic
script_location = app/alembic

# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
Expand Down

3 changes: 0 additions & 3 deletions
src/backend/app/.gitignore

View file


Open in desktop


This file was deleted.


0
src/backend/app/app/__init__.py → src/backend/app/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/__init__.py → src/backend/app/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/__init__.py → src/backend/app/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/api_v1/api.py → src/backend/app/api/api_v1/api.py

View file


Open in desktop


File renamed without changes.


0
.../app/app/api/api_v1/endpoints/__init__.py → ...kend/app/api/api_v1/endpoints/__init__.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/items.py → ...backend/app/api/api_v1/endpoints/items.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/login.py → ...backend/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/users.py → ...backend/app/api/api_v1/endpoints/users.py

View file


Open in desktop


File renamed without changes.


0
...end/app/app/api/api_v1/endpoints/utils.py → ...backend/app/api/api_v1/endpoints/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/api/deps.py → src/backend/app/api/deps.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/backend_pre_start.py → src/backend/app/backend_pre_start.py

View file


Open in desktop


File renamed without changes.


0
...backend/app/app/celeryworker_pre_start.py → src/backend/app/celeryworker_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/__init__.py → src/backend/app/core/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/celery_app.py → src/backend/app/core/celery_app.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/config.py → src/backend/app/core/config.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/core/security.py → src/backend/app/core/security.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/__init__.py → src/backend/app/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/base.py → src/backend/app/crud/base.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_item.py → src/backend/app/crud/crud_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/crud/crud_user.py → src/backend/app/crud/crud_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/__init__.py → src/backend/app/db/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/engine.py → src/backend/app/db/engine.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/db/init_db.py → src/backend/app/db/init_db.py

View file


Open in desktop


File renamed without changes.


0
...pp/email-templates/build/new_account.html → ...pp/email-templates/build/new_account.html

View file


Open in desktop


File renamed without changes.


0
...email-templates/build/reset_password.html → ...email-templates/build/reset_password.html

View file


Open in desktop


File renamed without changes.


0
...app/email-templates/build/test_email.html → ...app/email-templates/build/test_email.html

View file


Open in desktop


File renamed without changes.


0
.../app/email-templates/src/new_account.mjml → .../app/email-templates/src/new_account.mjml

View file


Open in desktop


File renamed without changes.


0
...p/email-templates/src/reset_password.mjml → ...p/email-templates/src/reset_password.mjml

View file


Open in desktop


File renamed without changes.


0
...p/app/email-templates/src/test_email.mjml → ...d/app/email-templates/src/test_email.mjml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/initial_data.py → src/backend/app/initial_data.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/main.py → src/backend/app/main.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/models.py → src/backend/app/models.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/__init__.py → src/backend/app/schemas/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/item.py → src/backend/app/schemas/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/msg.py → src/backend/app/schemas/msg.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/token.py → src/backend/app/schemas/token.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/schemas/user.py → src/backend/app/schemas/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/.gitignore → src/backend/app/tests/.gitignore

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/__init__.py → src/backend/app/tests/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/api/__init__.py → src/backend/app/tests/api/__init__.py

View file


Open in desktop


File renamed without changes.


0
...kend/app/app/tests/api/api_v1/__init__.py → src/backend/app/tests/api/api_v1/__init__.py

View file


Open in desktop


File renamed without changes.


0
...d/app/app/tests/api/api_v1/test_celery.py → ...ckend/app/tests/api/api_v1/test_celery.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_items.py → ...ackend/app/tests/api/api_v1/test_items.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_login.py → ...ackend/app/tests/api/api_v1/test_login.py

View file


Open in desktop


File renamed without changes.


0
...nd/app/app/tests/api/api_v1/test_users.py → ...ackend/app/tests/api/api_v1/test_users.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/conftest.py → src/backend/app/tests/conftest.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/__init__.py → src/backend/app/tests/crud/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_item.py → src/backend/app/tests/crud/test_item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/crud/test_user.py → src/backend/app/tests/crud/test_user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/__init__.py → src/backend/app/tests/utils/__init__.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/item.py → src/backend/app/tests/utils/item.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/user.py → src/backend/app/tests/utils/user.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests/utils/utils.py → src/backend/app/tests/utils/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/tests_pre_start.py → src/backend/app/tests_pre_start.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/utils.py → src/backend/app/utils.py

View file


Open in desktop


File renamed without changes.


0
src/backend/app/app/worker.py → src/backend/app/worker.py

View file


Open in desktop


File renamed without changes.


17 changes: 9 additions & 8 deletions
src/backend/backend.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,18 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

COPY ./app /app
ENV PYTHONPATH=/app

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

17 changes: 6 additions & 11 deletions
src/backend/celeryworker.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,26 +9,21 @@ RUN curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python
 poetry config virtualenvs.create false

# Copy poetry.lock* in case it doesn't exist in the repo
COPY ./app/pyproject.toml ./app/poetry.lock* /app/
COPY ./pyproject.toml ./poetry.lock* /app/

# Allow installing dev dependencies to run tests
ARG INSTALL_DEV=false
RUN bash -c "if [ $INSTALL_DEV == 'true' ] ; then poetry install --no-root ; else poetry install --no-root --only main ; fi"

# For development, Jupyter remote kernel, Hydrogen
# Using inside the container:
# jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
ARG INSTALL_JUPYTER=false
RUN bash -c "if [ $INSTALL_JUPYTER == 'true' ] ; then pip install jupyterlab ; fi"

ENV C_FORCE_ROOT=1

COPY ./app /app
WORKDIR /app

ENV PYTHONPATH=/app

COPY ./app/worker-start.sh /worker-start.sh
COPY ./alembic.ini /app/

COPY ./worker-start.sh /worker-start.sh

COPY ./app /app/app

RUN chmod +x /worker-start.sh

Expand Down

0
src/backend/app/mypy.ini → src/backend/mypy.ini

View file


Open in desktop


File renamed without changes.


0
src/backend/app/prestart.sh → src/backend/prestart.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/pyproject.toml → src/backend/pyproject.toml

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format-imports.sh → src/backend/scripts/format-imports.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/format.sh → src/backend/scripts/format.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/lint.sh → src/backend/scripts/lint.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test-cov-html.sh → src/backend/scripts/test-cov-html.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/scripts/test.sh → src/backend/scripts/test.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/tests-start.sh → src/backend/tests-start.sh

View file


Open in desktop


File renamed without changes.


0
src/backend/app/worker-start.sh → src/backend/worker-start.sh

View file


Open in desktop


File renamed without changes.


8 changes: 2 additions & 6 deletions
src/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,32 +49,28 @@ services:
 ports:
 - "8888:8888"
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}
 # command: sleep infinity # Infinite loop to keep container alive doing nothing
 command: /start-reload.sh

 celeryworker:
 volumes:
 - ./backend/app:/app
 - ./backend/:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-true}
 INSTALL_JUPYTER: ${INSTALL_JUPYTER-true}

 frontend:
 build:
Expand Down