ETL of data (see sources). Data engineering provides structure/unstructure? db of strain information for returns through API and construction of structured data for recommendation engine development. REST API for user search query and return of recomendations from engine Recommendation engine
Source List of used data:
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Python >= 3.6.8 Anaconda or MiniConda or Pip
This application does not need to be installed. It will run as a stanalone server with provided directories in this repository.
- Conda: Create a conda environment for the django application with
conda env create -f django_env.yml
- Run server with
python manage.py runserver <ip_address>:<port>
IP address and port are optional parameters for runserver.
A tests.py file is available in djapi/recommender/. The custom tests will require an active django instance running at available port and configured through params at the top of the file. Change 'devURL': http://:/ to the instance address. http:// prefix is required for context in the requests library.
Run the tests with
python tests.py
Test logging stored in tests/test_log.txt
Currently deployed to Heroku https://morning-badlands-32563.herokuapp.com
All endpoints are active, but not populated as of v0.1. Users, groups, strains, and userrating are available but not in use. Available for testing purposes only.
You can access the recommender api by passing a search string to:
- Django - The web framework used
- Django REST framework - API endpoint extension for Django
- Jupyter - Test ETL's and Develop Predictive Model
We use SemVer for versioning. For the versions available, see the tags on this repository.
The current project is pre-alpha and not yet versioned (default 0.0.1)
- Steve Elliott - Transformation & Loading - GitHubLink
- Vincent Brandon - Django API - GitHubLink
- Eric Wuerfel - Recommender Engine - GitHubLink
TODO See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
Backend Developers: