erose357 / flask_engine

flask_engine

Flask Engine is the Turing School's Rales Engine project written in Python. It is an API returning JSON from the SalesEngine data set.

hosted at: https://flask-engine-api.herokuapp.com/

Getting Started

Versions

Python 3.6.4
Flask 0.12.2
Postgresql 9.6.3

Prerequisites

Python3
Pipenv
Postgresql

Setup

Database setup:

create database in psql:

$ psql
username=# CREATE DATABASE flask_engine;
CREATE DATABASE
\q

App Setup/Installation:

clone the repo and cd into the directory:

$ git clone [email protected]:erose357/flask_engine.git
$ cd flask_engine

install dependencies:
$ pipenv install

set the following environment variables(MacOS):

$ export FLASK_APP=run.py
$ export APP_SETTINGS=development
$ export DATABASE_URL=<YOUR_DB_PATH>

activate the virtual environment:

$ pipenv shell
Spawning environment shell (/bin/bash). Use 'exit' to leave.
bash-3.2$ source .local/share/virtualenvs/flask_engine-wL03M76k/bin/activate
(flask_engine-wL03M76k) bash-3.2$

migrate the database:

(flask_engine-wL03M76k) bash-3.2$ python manage.py db upgrade
INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> 5488175015cc, empty message

seed the database:

(flask_engine-wL03M76k) bash-3.2$ python manage.py seed
merchants table seeded
customers table seeded
items table seeded
invoices table seeded
transactions table seeded
invoice_items table seeded

run the app:

(flask_engine-wL03M76k) bash-3.2$ flask run
 * Serving Flask app "run"
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

the root path gives an explanation of the currently available endpoints

flask_engine's Issues

GET /api/v1/merchants/:id/items

returns a collection of items associated with that merchant

GET /api/v1/customers/:id

Each data category should include a show action which renders a JSON representation of the appropriate record

GET /api/v1/customers

Each data category should include an index action which renders a JSON representation of all the appropriate records

GET /api/v1/transactions/find_all?parameters

Each category should offer find_all finders which should return all matches for the given query. It should work with any of the attributes defined on the data type and always be case insensitive

Deploy back-end

Start building back-end application

DB migrations

GET /api/v1/merchants/random

Returns a random resource

GET /api/v1/transactions/1

Each data category should include a show action which renders a JSON representation of the appropriate record

GET /api/v1/merchants/1

Each data category should include a show action which renders a JSON representation of the appropriate record

GET /api/v1/transactions

Merchant components and consume back-end

GET /api/v1/customers/:id/transactions

returns a collection of associated transactions

try to reorder json

json returned from the endpoints looks to be sorted alphabetically by first letter, look into orderdict

GET api/v1/merchants/find_all?parameters

Each category should offer find_all finders which should return all matches for the given query. It should work with any of the attributes defined on the data type and always be case insensitive

Decide what ORM to use and set up with Postgresql

GET /api/v1/transactions/find?parameters

Each data category should offer find finders to return a single object representation. The finder should work with any of the attributes defined on the data type and always be case insensitive

Learn Basic Python Syntax

DB seed

GET /api/v1/merchants

Each data category should include an index action which renders a JSON representation of all the appropriate records

Deploy front-end

GET /api/v1/customers/:id/invoices

returns a collection of associated invoices

Add explanation page to root path

Evaluate and Decide on web framework

Flask or Django

add README

GET /api/v1/merchants/find?parameters

Each data category should offer find finders to return a single object representation. The finder should work with any of the attributes defined on the data type and always be case insensitive

add CORS

change 'not found' from 500 to 404 error code

Build basic front-end structure

GET /api/v1/merchants/:id/invoices

returns a collection of invoices associated with that merchant from their known orders

GET /api/v1/customers/random

Returns a random resource

GET /api/v1/transactions/random