Initial setup of the curriculumAPI package.

- Used Blueprints to create two different modules - API module will be a RESTful service for curriculum data - Explorer module will serve the explore website

Author: eagraf

.gitignore

@@ -0,0 +1,2 @@
+venv
+*.egg-info

README.md

@@ -0,0 +1,28 @@
+# curriculumAPI
+This is the backend that will support both the curriculum website and the plugin.
+It will interface these frontends with the database and curriculum repository.
+
+## Setup
+Setup the virtual environment.
+```
+python3 -m venv venv
+```
+Every time you work on the project, start up venv:
+```
+. venv/bin/activate
+```
+Install Flask:
+```
+pip install Flask
+```
+Windows instructions at http://flask.pocoo.org/docs/1.0/installation/#installation
+
+## Running for the first time
+```
+export FLASK_APP=curriculumAPI
+pip install -e .
+flask run
+```
+Instructions may be different on Windows.
+
+

curriculumAPI/__init__.py

@@ -0,0 +1,7 @@
+from flask import Flask
+from curriculumAPI.api import curriculum_api
+from curriculumAPI.explorer import explorer
+
+app = Flask(__name__)
+app.register_blueprint(curriculum_api, url_prefix='/api')
+app.register_blueprint(explorer)

curriculumAPI/api.py

@@ -0,0 +1,7 @@
+from flask import Blueprint
+
+curriculum_api = Blueprint('curriculum_api', __name__, template_folder='templates')
+
+@curriculum_api.route('/test')
+def test():
+ return 'API test'

curriculumAPI/explorer.py

@@ -0,0 +1,7 @@
+from flask import Blueprint
+
+explorer = Blueprint('explorer', __name__, template_folder='templates')
+
+@explorer.route('/test')
+def test():
+ return 'Explorer test'

setup.py

@@ -0,0 +1,10 @@
+from setuptools import setup
+
+setup(
+ name='curriculumAPI',
+ packages=['curriculumAPI'],
+ include_package_data=True,
+ install_requires=[
+ 'flask',
+ ],
+)