Initial repository desgion (#2)

Initial attempt at some structuring of the repo
PaulJWright · Aug 3, 2024 · faeb245 · faeb245
1 parent eebd8dc
commit faeb245
Showing 10 changed files with 61 additions and 103 deletions.
diff --git a/...d_salads/example_subpkg/tests/__init__.py → docker/__init__.py b/...d_salads/example_subpkg/tests/__init__.py → docker/__init__.py
diff --git a/weird_salads/README.rst b/weird_salads/README.rst
@@ -0,0 +1,61 @@
+Overview
+--------
+
+* api (FastAPI)
+* data [small data files (if needed), probably where the SQLite DB will be stored...]
+* database (scripts alembic migrations)
+* inventory [deals with inventory-related tasks]
+* order [deals with the order tasks]
+* streamlit_app (streamlit frontend)
+* tests [openastronomy location for tests]
+
+
+Repository Layout
+=================
+
+Below is the proposed directory structure for the `weird_salads` project:
+
+.. code-block:: text
+
+    weird_salads/
+    ├── weird_salads/                   # Main application package
+    │   ├── README.rst
+    │   ├── data/                       # Small data-related files (/SQLite DB)
+    │   ├── database/                   # DB related utils, e.g. alembic
+    │   ├── api/                        # FastAPI-related code
+    │   │   ├── __init__.py
+    │   │   ├── app.py                  # FastAPI app and routers
+    │   │   ├── endpoints/
+    │   │   ├── schemas/
+    │   │   │   ├── orders_schema.py    # Orders Pydantic schemas
+    │   │   │   └── inventory_schema.py # Inventory Pydantic schemas
+    │   │   └── ...
+    │   ├── inventory/                  # Inventory module
+    │   │   ├── inventory_service/      # Business logic
+    │   │   │   ├── exceptions.py       # inventory-specific exceptions
+    │   │   │   ├── inventory_service.py
+    │   │   │   └── ...
+    │   │   ├── repository/             # Data layer access
+    │   │   │   ├── __init__.py
+    │   │   │   ├── inventory_repository.py
+    │   │   │   ├── models.py
+    │   │   │   └── ...
+    │   │   └── ...
+    │   ├── orders/                     # Orders module (similar to Inventory)
+    │   │   ├── orders_service/
+    │   │   │   ├── exceptions.py
+    │   │   │   ├── orders_service.py
+    │   │   │   └── orders.py
+    │   │   ├── repository/
+    │   │   │   ├── __init__.py
+    │   │   │   ├── orders_repository.py
+    │   │   │   ├── models.py
+    │   │   │   └── ...
+    │   │   └── ...
+    │   ├── streamlit_app/              # Streamlit frontend
+    │   ├── tests/                      # Unit and integration tests
+    │   ├── utils/                      # Shared utility functions
+    │   │   ├── unit_of_work.py         # Unit of work for transaction management
+    │   │   └── ...
+    │   └── version.py                  # Version information
+    └── ...
diff --git a/weird_salads/example_subpkg/data/.gitignore → weird_salads/api/__init__.py b/weird_salads/example_subpkg/data/.gitignore → weird_salads/api/__init__.py
diff --git a/weird_salads/example_mod.py b/weird_salads/example_mod.py
diff --git a/weird_salads/example_subpkg/__init__.py b/weird_salads/example_subpkg/__init__.py
diff --git a/weird_salads/inventory/__init__.py b/weird_salads/inventory/__init__.py
diff --git a/weird_salads/orders/__init__.py b/weird_salads/orders/__init__.py
diff --git a/weird_salads/streamlit_app/__init__,py b/weird_salads/streamlit_app/__init__,py
diff --git a/weird_salads/tests/test_example.py b/weird_salads/tests/test_example.py
diff --git a/weird_salads/utils/__init__.py b/weird_salads/utils/__init__.py