Location resource classes

.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+# var
+cache/
+*.db

README.md

@@ -1,10 +1,50 @@
 # PWP SPRING 2024
-# PROJECT NAME
+# Inventory Sytstem for Foodmarket Chain
 # Group information
-* Student 1. Name and email
-* Student 2. Name and email
-* Student 3. Name and email
-* Student 4. Name and email
+* Student 1. Alexis Chambers	[email protected]
+* Student 2. Zeeshan	Talha	[email protected]
+* Student 3. Reed	Connor	[email protected]
+* Student 4. Chakal	Khalil	[email protected]
+
+
+## Project Setup
+
+Clone the repository to your local machine using git clone
+```
+git clone https://github.com/khacha329/PWP_CrustyCrabs.git
+```
+To ensure your python packages are protected, set up a virtual environment to keep a clean system
+
+```
+python -m venv /path/to/myEnv
+```
+Activate the virtual environment
+
+```
+source /path/to/myEnv/bin/activate
+```
+Install the required python packages in the virtual environment using the requirements.txt file located in the root directory of this project
+
+```
+pip install requirements.txt -r
+```
+
+Intall inventory manager package in developer mode:
+Navigate to /PWP_CrustyCrabs/
+
+Run:
+
+```
+pip install -e .
+```
+
+
+## Initialize and Populate DB
+
+To intialize the database and populate it with dummy data follow the [README file](https://github.com/khacha329/PWP_CrustyCrabs/blob/main/inventorymanager/README.md) under the inventorymanager folder
+
+
+
 
 __Remember to include all required documentation and HOWTOs, including how to create and populate the database, how to run and test the API, the url to the entrypoint and instructions on how to setup and run the client__
 

inventorymanager/README.md

@@ -0,0 +1,21 @@
+To initialize the database for this application, run the following commands from the root directory of the project
+
+```
+flask --app inventorymanager init-db
+flask --app inventorymanager populate-db
+```
+To check the contents of the database, run the flask shell using the following command from the root directory of the project
+
+```
+flask --app inventorymanager shell
+```
+
+This will open an interactive flask-shell in which we can query the database. For a quick overview of each model, run any of the following commands in the shell:
+
+```
+Location.query.all()
+Warehouse.query.all()
+Item.query.all()
+Stock.query.all()
+Catalogue.query.all()
+```

inventorymanager/__init__.py

@@ -0,0 +1,59 @@
+"""
+This module is used to start and retrieve a Flask application complete with all the required setups
+"""
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+import os
+
+from inventorymanager.config import Config
+
+db = SQLAlchemy()
+
+# Structure learned from the following sources:
+# https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/quickstart/
+# https://www.digitalocean.com/community/tutorials/how-to-structure-a-large-flask-application-with-flask-blueprints-and-flask-sqlalchemy#the-target-application-structure
+# https://www.digitalocean.com/community/tutorials/how-to-use-flask-sqlalchemy-to-interact-with-databases-in-a-flask-application#step-2-setting-up-the-database-and-model
+
+
+def create_app(test_config=None):
+
+    app = Flask(__name__, instance_relative_config=True)
+
+    app.config.from_mapping(
+        SECRET_KEY="dev",
+        SQLALCHEMY_DATABASE_URI="sqlite:///" + os.path.join(app.instance_path, "development.db"),
+        SQLALCHEMY_TRACK_MODIFICATIONS=False,
+        # CACHE_TYPE="FileSystemCache",
+        # CACHE_DIR=os.path.join(app.instance_path, "cache"),
+    )
+
+    if test_config is None:
+        app.config.from_pyfile("config.py", silent=True)
+    else:
+        app.config.from_mapping(test_config)
+
+    try:
+        os.makedirs(app.instance_path)
+
+    except OSError:
+        pass
+
+    db.init_app(app)
+    #cache.init_app(app)
+
+    # Import All Models (not sure why yet, its a thing-to-do to make this work)
+    from inventorymanager.models import Location, Warehouse, Item, Stock, Catalogue
+
+    # CLI commands to populate db
+    from inventorymanager.models import init_db_command, create_dummy_data
+
+    app.cli.add_command(init_db_command)
+    app.cli.add_command(create_dummy_data)
+
+    from inventorymanager.api import api_bp
+    from inventorymanager.utils import WarehouseConverter, ItemConverter
+    app.url_map.converters["warehouse"] = WarehouseConverter
+    app.url_map.converters["item"] = ItemConverter
+    app.register_blueprint(api_bp)
+
+    return app

inventorymanager/api.py

@@ -0,0 +1,22 @@
+"""
+This module instantiates the Api object and adds to it all the endpoints for the resources
+"""
+from flask import Blueprint
+from flask_restful import Api
+
+from inventorymanager import create_app
+from inventorymanager.resources.item import ItemCollection, ItemItem
+from inventorymanager.resources.location import LocationCollection, LocationItem
+
+api_bp = Blueprint("api", __name__, url_prefix="/api")
+
+api = Api(api_bp)
+
+api.add_resource(ItemCollection, "/items/")
+api.add_resource(ItemItem, "/items/<item:item>/")
+api.add_resource(LocationCollection, "/locations/locations/")
+api.add_resource(LocationItem, '/api/locations/<int:location_id>')
+# api.add_resource(SensorItem, "/sensors/<sensor:sensor>/")
+# api.add_resource(LocationItem, "/locations/<location>/")
+# api.add_resource(MeasurementCollection, "/sensors/<sensor:sensor>/measurements/")
+# api.add_resource(LocationSensorPairing, "/locations/<location>/<sensor>/")

inventorymanager/config.py

@@ -0,0 +1,11 @@
+"""
+This module contains configuration settings to set up the database
+"""
+import os
+
+basedir = os.path.abspath(os.path.dirname(__file__))
+
+class Config:
+   SECRET_KEY = 'dev'
+   SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'app.db') 
+   SQLALCHEMY_TRACK_MODIFICATIONS = False

inventorymanager/constants.py

@@ -0,0 +1,11 @@
+"""
+This module contains constants used by the API
+"""
+#just copied this stuff, no idea what it does
+
+# MASON = "application/vnd.mason+json"
+# LINK_RELATIONS_URL = "/sensorhub/link-relations/"
+# ERROR_PROFILE = "/profiles/error/" 
+# SENSOR_PROFILE = "/profiles/sensor/"
+
+# MEASUREMENT_PAGE_SIZE = 50