lizequn / flaskrestful-comic

lightweight flask restful server

---

1. Dependency

   Using poetry to manage the dependency and python env. You may find the dependencies in pyproject.toml file.

   To install poetry via pip:

   $ pip install --user poetry

   Install dependency

   $ poetry install

   Run the server with project's virtualenv

   $ poetry shell
   $ python run.py 

   or

   $ poetry run python run.py

2. Structure of project

   -root
      -app 
          -models // Model DAO related file
          -resources // Controller and Service restful request end-point
          __init__.py // include router mapping
      -client // will delete
      -config.py //config file of project(include secret key for security hash)
      -run.py // python run.py to run the server
   

3. Alembic: database migration

   • init alembic

    $ alembic init alembic

   • define database schemas in app.schemas
   • set auto generation target metadata in env.py
   • generate migration code

    $ alembic revision --autogenerate -m "init table" 

   • add init role data

    $ alembic revision -m "Init role data"  

   • do migration and initialization

     $ alembic upgrade head