README.md

Ormdantic Starter

[WIP] A starter template for Ormdantic, a Python ORM using Pydantic and SQLAlchemy.

Project setup

# clone the repo
$ git clone https://github.com/yezz123/TodoList-Ormdantic-starter.git

# move to the project folder
$ cd TodoList-Ormdantic-starter

Creating virtual environment

• Create a virtual environment using virtualenv.

# creating virtual environment
$ virtualenv venv

# activate virtual environment
$ source venv/bin/activate

# install all dependencies
$ pip install -r requirements.txt

Running the Application

• To run the Main we need to use uvicorn a lightning-fast ASGI server implementation, using uvloop and httptools.

# Running the application using uvicorn
$ uvicorn main:app --reload

TODO

• Setup Repository
• Setup Routes & Schema
• Support all Ormdantic features
  • Create or Insert
  • Delete
  • Find Many
  • Find One
  • Update and Upsert
• Add Tests
• Add CI/CD
• Setup More Features
  • Authentication
  • Authorization
  • Pagination
  • Sorting
  • Filtering
  • Caching
  • Rate Limiting
  • Logging
  • Monitoring
  • Error Handling
  • Documentation
  • Deployment