improved code layout

piccolo-orm · Oct 29, 2019 · bc1f1fa · bc1f1fa
1 parent 0e3dd9d
commit bc1f1fa
Show file tree

Hide file tree

Showing 23 changed files with 35 additions and 28 deletions.
diff --git a/docs/source/endpoints/crud.rst → docs/source/crud/endpoints.rst b/docs/source/endpoints/crud.rst → docs/source/crud/endpoints.rst
@@ -20,7 +20,7 @@ Using it is as simple as this:
 
 .. code-block:: python
 
-    from piccolo_api.endpoints.crud import PiccoloCRUD
+    from piccolo_api.crud.endpoints import PiccoloCRUD
 
     from .tables import MyTable
 
@@ -39,7 +39,7 @@ To expose several CRUD endpoints in our app, we use Starlette's Router.
 
 .. code-block:: python
 
-    from piccolo_api.endpoints.crud import PiccoloCRUD
+    from piccolo_api.crud.endpoints import PiccoloCRUD
     from starlette.routing import Mount, Router
 
     from .tables import Table1, Table2, Table3

diff --git a/docs/source/crud/index.rst b/docs/source/crud/index.rst
@@ -0,0 +1,7 @@
+CRUD
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   ./endpoints
diff --git a/docs/source/csp/index.rst b/docs/source/csp/index.rst
@@ -0,0 +1,7 @@
+CSP
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   ./middleware
diff --git a/docs/source/middleware/csp.rst → docs/source/csp/middleware.rst b/docs/source/middleware/csp.rst → docs/source/csp/middleware.rst
@@ -7,7 +7,7 @@ against cross site scripting.
 
 .. code-block:: python
 
-    from piccolo_api.middleware.csp import CSPMiddleware
+    from piccolo_api.csp.middleware import CSPMiddleware
 
     wrapped_asgi_app = CSPMiddleware(asgi_app)
 

diff --git a/docs/source/endpoints/index.rst b/docs/source/endpoints/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,5 +9,6 @@ tables into a working REST API, using ASGI.
    :maxdepth: 2
    :caption: Contents:
 
-   ./endpoints/index
-   ./middleware/index
+   ./crud/index
+   ./csp/index
+   ./jwt/index
diff --git a/docs/source/endpoints/jwt.rst → docs/source/jwt/endpoints.rst b/docs/source/endpoints/jwt.rst → docs/source/jwt/endpoints.rst
@@ -6,7 +6,7 @@ This creates an endpoint for logging in, and getting a JSON Web Token (JWT).
 .. code-block:: python
 
     from starlette.routing import Route, Router
-    from piccolo_api.endpoints.auth import jwt_login
+    from piccolo_api.jwt_auth.endpoints import jwt_login
 
     from .tables import User
     from settings import SECRET

diff --git a/docs/source/jwt/index.rst b/docs/source/jwt/index.rst
@@ -0,0 +1,8 @@
+JWT
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   ./endpoints
+   ./middleware
diff --git a/docs/source/middleware/jwt.rst → docs/source/jwt/middleware.rst b/docs/source/middleware/jwt.rst → docs/source/jwt/middleware.rst
diff --git a/docs/source/middleware/index.rst b/docs/source/middleware/index.rst
diff --git a/piccolo_api/endpoints/crud.py → piccolo_api/crud/endpoints.py b/piccolo_api/endpoints/crud.py → piccolo_api/crud/endpoints.py
diff --git a/piccolo_api/middleware/csp.py → piccolo_api/csp/middleware.py b/piccolo_api/middleware/csp.py → piccolo_api/csp/middleware.py
diff --git a/piccolo_api/endpoints/auth.py → piccolo_api/jwt_auth/endpoints.py b/piccolo_api/endpoints/auth.py → piccolo_api/jwt_auth/endpoints.py
diff --git a/piccolo_api/middleware/auth.py → piccolo_api/jwt_auth/middleware.py b/piccolo_api/middleware/auth.py → piccolo_api/jwt_auth/middleware.py
diff --git a/piccolo_api/middleware/__init__.py b/piccolo_api/middleware/__init__.py
diff --git a/piccolo_api/endpoints/session.py → piccolo_api/session_auth/endpoints.py b/piccolo_api/endpoints/session.py → piccolo_api/session_auth/endpoints.py
@@ -12,7 +12,7 @@
 from starlette.status import HTTP_303_SEE_OTHER
 from starlette.templating import Jinja2Templates
 
-from piccolo_api.tables.sessions import SessionsBase
+from piccolo_api.session_auth.tables import SessionsBase
 
 
 TEMPLATES = Jinja2Templates(

diff --git a/piccolo_api/middleware/session.py → piccolo_api/session_auth/middleware.py b/piccolo_api/middleware/session.py → piccolo_api/session_auth/middleware.py
@@ -3,7 +3,7 @@
 import typing as t
 
 from piccolo.extensions.user import BaseUser as PiccoloBaseUser
-from piccolo_api.tables.sessions import SessionsBase
+from piccolo_api.session_auth.tables import SessionsBase
 from starlette.authentication import (
     AuthenticationBackend,
     AuthCredentials,

diff --git a/piccolo_api/tables/sessions.py → piccolo_api/session_auth/tables.py b/piccolo_api/tables/sessions.py → piccolo_api/session_auth/tables.py
diff --git a/piccolo_api/endpoints/templates/login.html → ...olo_api/session_auth/templates/login.html b/piccolo_api/endpoints/templates/login.html → ...olo_api/session_auth/templates/login.html
diff --git a/piccolo_api/endpoints/__init__.py → piccolo_api/shared/middleware/__init__.py b/piccolo_api/endpoints/__init__.py → piccolo_api/shared/middleware/__init__.py
diff --git a/piccolo_api/middleware/junction.py → piccolo_api/shared/middleware/junction.py b/piccolo_api/middleware/junction.py → piccolo_api/shared/middleware/junction.py
diff --git a/tests/test_csp.py b/tests/test_csp.py
@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from piccolo_api.middleware.csp import CSPMiddleware, CSPConfig
+from piccolo_api.csp.middleware import CSPMiddleware, CSPConfig
 from starlette.testclient import TestClient
 
 

diff --git a/tests/test_session.py b/tests/test_session.py
@@ -11,9 +11,9 @@
 from starlette.routing import Mount, Route, Router
 from starlette.testclient import TestClient
 
-from piccolo_api.tables.sessions import SessionsBase
-from piccolo_api.endpoints.session import session_login
-from piccolo_api.middleware.session import SessionsAuthBackend
+from piccolo_api.session_auth.tables import SessionsBase
+from piccolo_api.session_auth.endpoints import session_login
+from piccolo_api.session_auth.middleware import SessionsAuthBackend
 
 
 SQLITE_PATH = os.path.join(os.path.dirname(__file__), "./session.sqlite")