/vest_test

Primary LanguagePython

VEST TEST

Requirements:

  • Python 3.6.9 >

Steps to install it:

  1. Clone the repository:
    git clone https://github.com/stevematos/api_rss_reader
  1. Create and activate the virtual environment:
    virtualenv env -p python3
    source env/bin/activate
  1. Install requirements:
    pip install -r requirements.txt
  1. Run the application, if you want to run it in dev mode add --reload:
    uvicorn main:app [--reload]

You can also run runserver.sh to deploy the application.

The application will be running at http://127.0.0.1:8000

If it is the first to be run by the application, the database will be created automatically in sqllite called database.db.

If you want to run the unit tests you do it with the command

    python -m unittest tests/endpoints.py

PSDT: A database called test.db will be created that is created when you start the tests and the tables will be dropped when the tests are finished.

PROJECT STRUCTURE

VEST_TEST
│   readme.md 
│   main.py
│   .gitignore
│   requirements.txt
│
└───api : package for using APIs
│   
└───crud: package use of the different interactions with the database
│   
└───db: contains everything related to database connections
│   
└───models: contains the database models used in the applications 
│   
└───schemas: schemes used in the application
│   
└───test: contains the application tests
│   
└───utils: functions that are reused in the application
│   
└───postman: application documentation, import the json into the postman to see the different endpoints and their examples.

Developed by: Steve Matos