initial commit

Author: jod35

.gitignore

@@ -0,0 +1,5 @@
+env
+__pycache__
+venv
+*.db
+*.sqlite3

README.md

@@ -0,0 +1,62 @@
+# Build a REST API with FastAPI, PostgreSQL and SQLAlchemy
+FastAPI is a Python framework and set of tools that allow developers to invoke commonly used functions using a REST interface. 
+
+SQLAlchemy is a package that makes it easier for Python programs to communicate with databases. Most of the time, this library is used as an Object Relational Mapper (ORM) tool, which automatically converts function calls to SQL queries and translates Python classes to tables on relational databases.
+
+Many web, mobile, geospatial, and analytics applications use PostgreSQL as their primary data storage or data warehouse.
+
+This is code I wrote for the [video](https://youtu.be/2g1ZjA6zHRo)
+
+## How to run the REST API
+Get this project from Github
+``` 
+git clone https://github.com/jod35/Build-a-fastapi-and-postgreSQL-API-with-SQLAlchemy
+ 
+```
+
+
+
+### Setting up the database
+
+* Install PostgreSQL and create your user and database
+
+* Change this line in ` database.py ` to 
+
+``` 
+engine=create_engine("postgresql://{YOUR_DATABASE_USER}:{YOUR_DATABASE_PASSWORD}@localhost/{YOUR_DATABASE_NAME}",
+    echo=True
+)
+```
+
+### Create a virtual environment
+This can be done with 
+``` python -m venv env ```
+
+activate the virtual environment with 
+
+``` 
+env/bin/activate
+```
+
+or 
+
+```
+env\Scripts\activate
+```
+
+
+
+### Install the requirements 
+
+``` 
+pip install -r requirements.txt
+```
+
+### Create the database
+``` python create_db.py ```
+
+## Run the API
+``` python main.py ```
+
+## Author 
+[Ssali Jonathan](https://github.com/jod35)

create_db.py

@@ -0,0 +1,6 @@
+from database import Base,engine
+from models import Item
+
+print("Creating database ....")
+
+Base.metadata.create_all(engine)

database.py

@@ -0,0 +1,11 @@
+from sqlalchemy.orm import declarative_base
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+engine=create_engine("postgresql://{YOUR_DATABASE_USER}:{YOUR_DATABASE_PASSWORD}@localhost/{YOUR_DATABASE_NAME}",
+    echo=True
+)
+
+Base=declarative_base()
+
+SessionLocal=sessionmaker(bind=engine)

main.py

@@ -0,0 +1,81 @@
+from os import stat
+from fastapi import FastAPI,status,HTTPException
+from pydantic import BaseModel
+from typing import Optional,List
+from database import SessionLocal
+import models
+
+app=FastAPI()
+
+class Item(BaseModel): #serializer
+    id:int
+    name:str
+    description:str
+    price:int
+    on_offer:bool
+
+    class Config:
+        orm_mode=True
+
+
+db=SessionLocal()
+
+@app.get('/items',response_model=List[Item],status_code=200)
+def get_all_items():
+    items=db.query(models.Item).all()
+
+    return items
+
+@app.get('/item/{item_id}',response_model=Item,status_code=status.HTTP_200_OK)
+def get_an_item(item_id:int):
+    item=db.query(models.Item).filter(models.Item.id==item_id).first()
+    return item
+
+@app.post('/items',response_model=Item,
+        status_code=status.HTTP_201_CREATED)
+def create_an_item(item:Item):
+    db_item=db.query(models.Item).filter(models.Item.name==item.name).first()
+
+    if db_item is not None:
+        raise HTTPException(status_code=400,detail="Item already exists")
+
+
+
+    new_item=models.Item(
+        name=item.name,
+        price=item.price,
+        description=item.description,
+        on_offer=item.on_offer
+    )
+
+
+    
+
+    db.add(new_item)
+    db.commit()
+
+    return new_item
+
+@app.put('/item/{item_id}',response_model=Item,status_code=status.HTTP_200_OK)
+def update_an_item(item_id:int,item:Item):
+    item_to_update=db.query(models.Item).filter(models.Item.id==item_id).first()
+    item_to_update.name=item.name
+    item_to_update.price=item.price
+    item_to_update.description=item.description
+    item_to_update.on_offer=item.on_offer
+
+    db.commit()
+
+    return item_to_update
+
+@app.delete('/item/{item_id}')
+def delete_item(item_id:int):
+    item_to_delete=db.query(models.Item).filter(models.Item.id==item_id).first()
+
+    if item_to_delete is None:
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND,detail="Resource Not Found")
+    
+    db.delete(item_to_delete)
+    db.commit()
+
+    return item_to_delete

models.py

@@ -0,0 +1,16 @@
+from sqlalchemy.sql.expression import null
+from database import Base
+from sqlalchemy import String,Boolean,Integer,Column,Text
+
+
+class Item(Base):
+    __tablename__='items'
+    id=Column(Integer,primary_key=True)
+    name=Column(String(255),nullable=False,unique=True)
+    description=Column(Text)
+    price=Column(Integer,nullable=False)
+    on_offer=Column(Boolean,default=False)
+
+
+    def __repr__(self):
+        return f"<Item name={self.name} price={self.price}>"

requirements.txt

@@ -0,0 +1,12 @@
+asgiref==3.3.4
+click==8.0.1
+colorama==0.4.4
+fastapi==0.65.2
+greenlet==1.1.0
+h11==0.12.0
+psycopg2-binary==2.9.1
+pydantic==1.8.2
+SQLAlchemy==1.4.19
+starlette==0.14.2
+typing-extensions==3.10.0.0
+uvicorn==0.14.0