From 6e312bd287ba9a8f92502a2f4b025d742541c3f2 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Sun, 4 Nov 2018 19:45:23 -0800 Subject: [PATCH] Rename the etiquette_flask backend package to backend. Alright, I got tired of confusing myself with the same-named outer and inner package. Keep in mind that every frontend implementation is supposed to be its own independent project where etiquette is nothing but a dependency. So the name backend is not ambiguous with the etiquette backend. --- README.md | 13 ++++++++----- .../{etiquette_flask => backend}/__init__.py | 0 .../{etiquette_flask => backend}/caching.py | 0 .../{etiquette_flask => backend}/common.py | 0 .../{etiquette_flask => backend}/decorators.py | 0 .../endpoints/__init__.py | 0 .../endpoints/album_endpoints.py | 0 .../endpoints/basic_endpoints.py | 0 .../endpoints/bookmark_endpoints.py | 0 .../endpoints/photo_endpoints.py | 0 .../endpoints/tag_endpoints.py | 0 .../endpoints/user_endpoints.py | 0 .../{etiquette_flask => backend}/helpers.py | 0 .../{etiquette_flask => backend}/jinja_filters.py | 0 .../{etiquette_flask => backend}/jsonify.py | 0 .../{etiquette_flask => backend}/sessions.py | 0 .../etiquette_flask/etiquette_flask_entrypoint.py | 6 +++--- 17 files changed, 11 insertions(+), 8 deletions(-) rename frontends/etiquette_flask/{etiquette_flask => backend}/__init__.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/caching.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/common.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/decorators.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/__init__.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/album_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/basic_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/bookmark_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/photo_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/tag_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/endpoints/user_endpoints.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/helpers.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/jinja_filters.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/jsonify.py (100%) rename frontends/etiquette_flask/{etiquette_flask => backend}/sessions.py (100%) diff --git a/README.md b/README.md index 739f80f..6d5b8f1 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,9 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make
Setting up via pythonpath -- The repository you're looking at right now is `D:\Git\Etiquette`. The toplevel `etiquette` folder is the main package. We want the repository to be treated as an alternative lib directory, because the package is a child of it. +- The repository you're looking at right now is `D:\Git\Etiquette`. The toplevel `etiquette` folder is the main package. + + The pythonpath points to directories that *contain* the packages you need to import, not to the packages themselves. Therefore we point to the repository. Windows: `set "PYTHONPATH=%PYTHONPATH%;D:\Git\Etiquette"` Note the semicolon to delimit paths. @@ -54,13 +56,16 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make Linux: /somewhere $ python /home/Owner/Git/Etiquette/frontends/etiquette_flask/etiquette_flask_launch.py 5001 +
---
Running with Gunicorn -1. Use the PYTHONPATH technique to make `etiquette` and `etiquette_flask` both importable. Symlinking into the lib is not as convenient here because the server relies on the static files and jinja templates relative to the code's location. +1. Use the PYTHONPATH technique to make `etiquette` and the flask `backend` both importable. Symlinking into the lib is not as convenient here because the server relies on the static files and jinja templates relative to the code's location. + + The Pythonpath points to directories that *contain* the packages you need to import, not to the packages themselves. Therefore we point to the etiquette and frontend repositories. PYTHONPATH="$PYTHONPATH:/home/Owner/Git/Etiquette:/home/Owner/Git/Etiquette/frontends/etiquette_flask @@ -87,9 +92,7 @@ Here is a brief overview of the project to help you learn your way around: - `frontends` Ideally, the backend should be frontend-agnostic. Even though the Flask interface is my primary interest, it should not feel like it must be the only one. Therefore I place it in this folder to indicate that other frontends are possible too. Every folder here is essentially a completely separate project. - `etiquette_flask` - This folder represents the flask server as somewhat of a black box, in the sense that you can move it around and just run the contained launch file. Subfolders contain the HTML templates, static files, and site code. - - `etiquette_flask` - The package that contains the site's actual API code. + This folder represents the flask server as somewhat of a black box, in the sense that you can move it around and just run the contained launch file. Subfolders contain the HTML templates, static files, and site's backend code. - `etiquette_repl` Preloads a few variables into the interpreter so you can quickly test functions within the Python REPL itself. - `utilities` diff --git a/frontends/etiquette_flask/etiquette_flask/__init__.py b/frontends/etiquette_flask/backend/__init__.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/__init__.py rename to frontends/etiquette_flask/backend/__init__.py diff --git a/frontends/etiquette_flask/etiquette_flask/caching.py b/frontends/etiquette_flask/backend/caching.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/caching.py rename to frontends/etiquette_flask/backend/caching.py diff --git a/frontends/etiquette_flask/etiquette_flask/common.py b/frontends/etiquette_flask/backend/common.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/common.py rename to frontends/etiquette_flask/backend/common.py diff --git a/frontends/etiquette_flask/etiquette_flask/decorators.py b/frontends/etiquette_flask/backend/decorators.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/decorators.py rename to frontends/etiquette_flask/backend/decorators.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/__init__.py b/frontends/etiquette_flask/backend/endpoints/__init__.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/__init__.py rename to frontends/etiquette_flask/backend/endpoints/__init__.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/album_endpoints.py b/frontends/etiquette_flask/backend/endpoints/album_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/album_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/album_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/basic_endpoints.py b/frontends/etiquette_flask/backend/endpoints/basic_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/basic_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/basic_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/bookmark_endpoints.py b/frontends/etiquette_flask/backend/endpoints/bookmark_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/bookmark_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/bookmark_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py b/frontends/etiquette_flask/backend/endpoints/photo_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/photo_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/photo_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/tag_endpoints.py b/frontends/etiquette_flask/backend/endpoints/tag_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/tag_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/tag_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/endpoints/user_endpoints.py b/frontends/etiquette_flask/backend/endpoints/user_endpoints.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/endpoints/user_endpoints.py rename to frontends/etiquette_flask/backend/endpoints/user_endpoints.py diff --git a/frontends/etiquette_flask/etiquette_flask/helpers.py b/frontends/etiquette_flask/backend/helpers.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/helpers.py rename to frontends/etiquette_flask/backend/helpers.py diff --git a/frontends/etiquette_flask/etiquette_flask/jinja_filters.py b/frontends/etiquette_flask/backend/jinja_filters.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/jinja_filters.py rename to frontends/etiquette_flask/backend/jinja_filters.py diff --git a/frontends/etiquette_flask/etiquette_flask/jsonify.py b/frontends/etiquette_flask/backend/jsonify.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/jsonify.py rename to frontends/etiquette_flask/backend/jsonify.py diff --git a/frontends/etiquette_flask/etiquette_flask/sessions.py b/frontends/etiquette_flask/backend/sessions.py similarity index 100% rename from frontends/etiquette_flask/etiquette_flask/sessions.py rename to frontends/etiquette_flask/backend/sessions.py diff --git a/frontends/etiquette_flask/etiquette_flask_entrypoint.py b/frontends/etiquette_flask/etiquette_flask_entrypoint.py index 0f539b9..f1729ed 100644 --- a/frontends/etiquette_flask/etiquette_flask_entrypoint.py +++ b/frontends/etiquette_flask/etiquette_flask_entrypoint.py @@ -7,8 +7,8 @@ gunicorn etiquette_flask_entrypoint:site --bind "0.0.0.0:PORT" --access-logfile import sys import werkzeug.contrib.fixers -import etiquette_flask +import backend -etiquette_flask.site.wsgi_app = werkzeug.contrib.fixers.ProxyFix(etiquette_flask.site.wsgi_app) +backend.site.wsgi_app = werkzeug.contrib.fixers.ProxyFix(backend.site.wsgi_app) -site = etiquette_flask.site +site = backend.site