The inventory service keeps track of how many of each product we have in our warehouse. It references a product id and the quantity on hand. This service also tracks restock levels and the condition of the item (i.e., new, open box, used) as an enumeration. Restock levels will help you know when to order more products. Each item has a "last updated on" field that tells the user when this item was added/updated/etc.
The user also has the ability to enable/disable updates of a given product ID and condition. This can prevent us from having too many copies of an item in our warehouse
The project uses honcho which gets it's commands from the Procfile. To start the service simply use:
honcho startYou should be able to reach the service at: http://localhost:8000. The port that is used is controlled by an environment variable defined in the .flaskenv file which Flask uses to load it's configuration from the environment by default.
After running honcho start, please click on the "API documentation is here" button on the homepage to bring up the Swagger Docs UI. The Swagger Docs UI explains how to call our API.
The project contains the following important files:
.gitignore - this will ignore vagrant and other metadata files
.flaskenv - Environment variables to configure Flask
.gitattributes - File to gix Windows CRLF issues
.devcontainers/ - Folder with support for VSCode Remote Containers
dot-env-example - copy to .env to use environment variables
requirements.txt - list if Python libraries required by your code
config.py - configuration parameters
.github/ - Folder for CI
└── ISSUE_TEMPLATE - Templates for Zenhub items
├── bug_report.md - Template for bug reports
├── user-story.md - Template for user stories
└── workflows - Folder for workflows
├── bdd.yml - Steps that auto-run BDD tests
├── tdd.yml - Steps that auto-run TDD tests
deploy/ - Folder for deployment files
├── deployment.yaml - YAML file for deployment
├── postgresql.yaml - YAML file for deploying postgres
└── service.yaml - YAML file for deploying service
features/ - Folder for features files
└── steps - Folder for steps files
├── inventory_steps.py - File for loading data into the background context table
├── web_steps.py - Contains functions for generic web interactions
├── environment.py - Defines environment variables and Selenium settings
├── inventory.feature - Defines BDD scenarios
service/ - service python package
└── common - common code package
├── error_handlers.py - HTTP error handling code
├── log_handlers.py - logging setup code
├── cli_commands.py
└── status.py - HTTP status constants
└── static - Contains Javascript and HTML code for the GUI
├── ...
├── __init__.py - package initializer
├── models.py - module with business models
├── config.py - Defines some more environment vars
├── utilities.py - Contains helper functions
├── routes.py - module with service routes
tests/ - test cases package
├── __init__.py - package initializer
├── factories.py - Makes objects for testing
├── parent_models.py - Contains base classes for unit tests
├── test_cli_commands.py - Tests the Flask CLI
├── test_models.py - test suite for business models
└── test_routes.py - test suite for service routes
Copyright (c) John Rofrano. All rights reserved.
Licensed under the Apache License. See LICENSE
This repository is part of the NYU masters class: CSCI-GA.2820-001 DevOps and Agile Methodologies created and taught by John Rofrano, Adjunct Instructor, NYU Courant Institute, Graduate Division, Computer Science, and NYU Stern School of Business.