Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 2 commits into from
Apr 19, 2019
Merged

Add Items (crud, models, endpoints), utils, refactor #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d336681
:sparkles: Add Items (crud, models, endpoints), utils, refactor
tiangolo Apr 19, 2019
1db9692
:memo: Update release notes
tiangolo Apr 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
* Update CRUD utils to use types better.
* Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
* Upgrade packages.
* Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
* Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
* Update testing utils.
* Update linting rules, relax vulture to reduce false positives.
* Update migrations to include new Items.
* Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down
4 changes: 3 additions & 1 deletion {{cookiecutter.project_slug}}/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`.

Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/backend/app/Pipfile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down
1,022 changes: 0 additions & 1,022 deletions {{cookiecutter.project_slug}}/backend/app/Pipfile.lock
View file
Open in desktop

This file was deleted.

21 changes: 18 additions & 3 deletions ...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises:
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
op.create_table('item',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('title', sa.String(), nullable=True),
sa.Column('description', sa.String(), nullable=True),
sa.Column('owner_id', sa.Integer(), nullable=True),
sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
sa.PrimaryKeyConstraint('id')
)
op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_index(op.f('ix_item_title'), table_name='item')
op.drop_index(op.f('ix_item_id'), table_name='item')
op.drop_index(op.f('ix_item_description'), table_name='item')
op.drop_table('item')
op.drop_index(op.f('ix_user_id'), table_name='user')
op.drop_index(op.f('ix_user_full_name'), table_name='user')
op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down
9 changes: 5 additions & 4 deletions {{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])
102 changes: 102 additions & 0 deletions {{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
db: Session = Depends(get_db),
skip: int = 0,
limit: int = 100,
current_user: DBUser = Depends(get_current_active_user),
):
"""
Retrieve items.
"""
if crud.user.is_superuser(current_user):
items = crud.item.get_multi(db, skip=skip, limit=limit)
else:
items = crud.item.get_multi_by_owner(
db_session=db, owner_id=current_user.id, skip=skip, limit=limit
)
return items


@router.post("/", response_model=Item)
def create_item(
*,
db: Session = Depends(get_db),
item_in: ItemCreate,
current_user: DBUser = Depends(get_current_active_user),
):
"""
Create new item.
"""
item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
return item


@router.put("/{id}", response_model=Item)
def update_item(
*,
db: Session = Depends(get_db),
id: int,
item_in: ItemUpdate,
current_user: DBUser = Depends(get_current_active_user),
):
"""
Update an item.
"""
item = crud.item.get(db_session=db, id=id)
if not item:
raise HTTPException(status_code=404, detail="Item not found")
if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
raise HTTPException(status_code=400, detail="Not enough permissions")
item = crud.item.update(db_session=db, item=item, item_in=item_in)
return item


@router.get("/{id}", response_model=Item)
def read_user_me(
*,
db: Session = Depends(get_db),
id: int,
current_user: DBUser = Depends(get_current_active_user),
):
"""
Get item by ID.
"""
item = crud.item.get(db_session=db, id=id)
if not item:
raise HTTPException(status_code=400, detail="Item not found")
if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
raise HTTPException(status_code=400, detail="Not enough permissions")
return item


@router.delete("/{id}", response_model=Item)
def delete_item(
*,
db: Session = Depends(get_db),
id: int,
current_user: DBUser = Depends(get_current_active_user),
):
"""
Delete an item.
"""
item = crud.item.get(db_session=db, id=id)
if not item:
raise HTTPException(status_code=404, detail="Item not found")
if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
raise HTTPException(status_code=400, detail="Not enough permissions")
item = crud.item.remove(db_session=db, id=id)
return item
0 ...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py
View file
Open in desktop
File renamed without changes.
39 changes: 19 additions & 20 deletions ...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
db: Session = Depends(get_db),
skip: int = 0,
limit: int = 100,
current_user: DBUser = Depends(get_current_active_superuser),
):
"""
Retrieve users
Retrieve users.
"""
users = crud.user.get_multi(db, skip=skip, limit=limit)
return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
*,
db: Session = Depends(get_db),
user_in: UserInCreate,
user_in: UserCreate,
current_user: DBUser = Depends(get_current_active_superuser),
):
"""
Create new user
Create new user.
"""
user = crud.user.get_by_email(db, email=user_in.email)
if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
*,
db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
current_user: DBUser = Depends(get_current_active_user),
):
"""
Update own user
Update own user.
"""
current_user_data = jsonable_encoder(current_user)
user_in = UserInUpdate(**current_user_data)
user_in = UserUpdate(**current_user_data)
if password is not None:
user_in.password = password
if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
db: Session = Depends(get_db),
current_user: DBUser = Depends(get_current_active_user),
):
"""
Get current user
Get current user.
"""
return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
*,
db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
full_name: str = Body(None),
):
"""
Create new user without the need to be logged in
Create new user without the need to be logged in.
"""
if not config.USERS_OPEN_REGISTRATION:
raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
status_code=400,
detail="The user with this username already exists in the system",
)
user_in = UserInCreate(password=password, email=email, full_name=full_name)
user_in = UserCreate(password=password, email=email, full_name=full_name)
user = crud.user.create(db, user_in=user_in)
return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
user_id: int,
current_user: DBUser = Depends(get_current_active_user),
db: Session = Depends(get_db),
):
"""
Get a specific user by id
Get a specific user by id.
"""
user = crud.user.get(db, user_id=user_id)
if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
*,
db: Session = Depends(get_db),
user_id: int,
user_in: UserInUpdate,
user_in: UserUpdate,
current_user: UserInDB = Depends(get_current_active_superuser),
):
"""
Update a user
Update a user.
"""
user = crud.user.get(db, user_id=user_id)

if not user:
raise HTTPException(
status_code=404,
Expand Down
8 changes: 4 additions & 4 deletions {{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
"""
Test Celery worker
Test Celery worker.
"""
celery_app.send_task("app.worker.test_celery", args=[msg.msg])
return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
"""
Test emails
Test emails.
"""
send_test_email(email_to=email_to)
return {"msg": "Test email sent"}
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add Items (crud, models, endpoints), utils, refactor#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 2 commits into

from

Apr 19, 2019
 Merged


Add Items (crud, models, endpoints), utils, refactor
#14
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d336681

:sparkles: Add Items (crud, models, endpoints), utils, refactor


tiangolo Apr 19, 2019
1db9692

:memo: Update release notes


tiangolo Apr 19, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,17 @@ After using this generator, your new project (the directory created) will contai

### Next release

* PR <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/14" target="_blank">#14</a>:
 * Update CRUD utils to use types better.
 * Simplify Pydantic model names, from `UserInCreate` to `UserCreate`, etc.
 * Upgrade packages.
 * Add new generic "Items" models, crud utils, endpoints, and tests. To facilitate re-using them to create new functionality. As they are simple and generic (not like Users), it's easier to copy-paste and adapt them to each use case.
 * Update endpoints/*path operations* to simplify code and use new utilities, prefix and tags in `include_router`.
 * Update testing utils.
 * Update linting rules, relax vulture to reduce false positives.
 * Update migrations to include new Items.
 * Update project README.md with tips about how to start with backend.

* Upgrade Python to 3.7 as Celery is now compatible too. <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/10" target="_blank">PR #10</a> by <a href="https://github.com/ebreton" target="_blank">@ebreton</a>.

### 0.2.2
Expand Down

4 changes: 3 additions & 1 deletion
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,9 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec

### General workflow

Add and modify SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models` and API endpoints in `./backend/app/app/api/`.
Open your editor at `./backend/app/` (instead of the project root: `./`), so that you see an `./app/` directory with your code inside. That way, your editor will be able to find all the imports, etc.

Modify or add SQLAlchemy models in `./backend/app/app/db_models/`, Pydantic models in `./backend/app/app/models/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.

Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`. 

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/Pipfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ pyjwt = "*"
python-multipart = "*"
email-validator = "*"
requests = "*"
celery = "~=4.3"
celery = "*"
passlib = {extras = ["bcrypt"],version = "*"}
tenacity = "*"
pydantic = "*"
Expand Down

1,022 changes: 0 additions & 1,022 deletions
{{cookiecutter.project_slug}}/backend/app/Pipfile.lock

View file


Open in desktop


This file was deleted.


21 changes: 18 additions & 3 deletions
...c/versions/e6ae69e9dcb9_first_revision.py → ...c/versions/d4867f3a4c0a_first_revision.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
"""First revision

Revision ID: e6ae69e9dcb9
Revision ID: d4867f3a4c0a
Revises: 
Create Date: 2019-02-13 14:27:57.038583
Create Date: 2019-04-17 13:53:32.978401

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'e6ae69e9dcb9'
revision = 'd4867f3a4c0a'
down_revision = None
branch_labels = None
depends_on = None
Expand All@@ -30,11 +30,26 @@ def upgrade():
 op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
 op.create_index(op.f('ix_user_full_name'), 'user', ['full_name'], unique=False)
 op.create_index(op.f('ix_user_id'), 'user', ['id'], unique=False)
 op.create_table('item',
 sa.Column('id', sa.Integer(), nullable=False),
 sa.Column('title', sa.String(), nullable=True),
 sa.Column('description', sa.String(), nullable=True),
 sa.Column('owner_id', sa.Integer(), nullable=True),
 sa.ForeignKeyConstraint(['owner_id'], ['user.id'], ),
 sa.PrimaryKeyConstraint('id')
 )
 op.create_index(op.f('ix_item_description'), 'item', ['description'], unique=False)
 op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False)
 op.create_index(op.f('ix_item_title'), 'item', ['title'], unique=False)
 # ### end Alembic commands ###


def downgrade():
 # ### commands auto generated by Alembic - please adjust! ###
 op.drop_index(op.f('ix_item_title'), table_name='item')
 op.drop_index(op.f('ix_item_id'), table_name='item')
 op.drop_index(op.f('ix_item_description'), table_name='item')
 op.drop_table('item')
 op.drop_index(op.f('ix_user_id'), table_name='user')
 op.drop_index(op.f('ix_user_full_name'), table_name='user')
 op.drop_index(op.f('ix_user_email'), table_name='user')
Expand Down

9 changes: 5 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/api.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
from fastapi import APIRouter

from app.api.api_v1.endpoints import token, user, utils
from app.api.api_v1.endpoints import items, login, users, utils

api_router = APIRouter()
api_router.include_router(token.router)
api_router.include_router(user.router)
api_router.include_router(utils.router)
api_router.include_router(login.router, tags=["login"])
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

102 changes: 102 additions & 0 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/items.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
from typing import List

from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.orm import Session

from app import crud
from app.api.utils.db import get_db
from app.api.utils.security import get_current_active_user
from app.db_models.user import User as DBUser
from app.models.item import Item, ItemCreate, ItemUpdate

router = APIRouter()


@router.get("/", response_model=List[Item])
def read_items(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Retrieve items.
 """
 if crud.user.is_superuser(current_user):
 items = crud.item.get_multi(db, skip=skip, limit=limit)
 else:
 items = crud.item.get_multi_by_owner(
 db_session=db, owner_id=current_user.id, skip=skip, limit=limit
 )
 return items


@router.post("/", response_model=Item)
def create_item(
 *,
 db: Session = Depends(get_db),
 item_in: ItemCreate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Create new item.
 """
 item = crud.item.create(db_session=db, item_in=item_in, owner_id=current_user.id)
 return item


@router.put("/{id}", response_model=Item)
def update_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 item_in: ItemUpdate,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.update(db_session=db, item=item, item_in=item_in)
 return item


@router.get("/{id}", response_model=Item)
def read_user_me(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get item by ID.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=400, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 return item


@router.delete("/{id}", response_model=Item)
def delete_item(
 *,
 db: Session = Depends(get_db),
 id: int,
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Delete an item.
 """
 item = crud.item.get(db_session=db, id=id)
 if not item:
 raise HTTPException(status_code=404, detail="Item not found")
 if not crud.user.is_superuser(current_user) and (item.owner_id != current_user.id):
 raise HTTPException(status_code=400, detail="Not enough permissions")
 item = crud.item.remove(db_session=db, id=id)
 return item

0
...end/app/app/api/api_v1/endpoints/token.py → ...end/app/app/api/api_v1/endpoints/login.py

View file


Open in desktop


File renamed without changes.


39 changes: 19 additions & 20 deletions
...kend/app/app/api/api_v1/endpoints/user.py → ...end/app/app/api/api_v1/endpoints/users.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,35 +10,35 @@
from app.api.utils.security import get_current_active_superuser, get_current_active_user
from app.core import config
from app.db_models.user import User as DBUser
from app.models.user import User, UserInCreate, UserInDB, UserInUpdate
from app.models.user import User, UserCreate, UserInDB, UserUpdate
from app.utils import send_new_account_email

router = APIRouter()


@router.get("/users/", tags=["users"], response_model=List[User])
@router.get("/", response_model=List[User])
def read_users(
 db: Session = Depends(get_db),
 skip: int = 0,
 limit: int = 100,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Retrieve users
 Retrieve users.
 """
 users = crud.user.get_multi(db, skip=skip, limit=limit)
 return users


@router.post("/users/", tags=["users"], response_model=User)
@router.post("/", response_model=User)
def create_user(
 *,
 db: Session = Depends(get_db),
 user_in: UserInCreate,
 user_in: UserCreate,
 current_user: DBUser = Depends(get_current_active_superuser),
):
 """
 Create new user
 Create new user.
 """
 user = crud.user.get_by_email(db, email=user_in.email)
 if user:
Expand All@@ -54,7 +54,7 @@ def create_user(
 return user


@router.put("/users/me", tags=["users"], response_model=User)
@router.put("/me", response_model=User)
def update_user_me(
 *,
 db: Session = Depends(get_db),
Expand All@@ -64,10 +64,10 @@ def update_user_me(
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Update own user
 Update own user.
 """
 current_user_data = jsonable_encoder(current_user)
 user_in = UserInUpdate(**current_user_data)
 user_in = UserUpdate(**current_user_data)
 if password is not None:
 user_in.password = password
 if full_name is not None:
Expand All@@ -78,18 +78,18 @@ def update_user_me(
 return user


@router.get("/users/me", tags=["users"], response_model=User)
@router.get("/me", response_model=User)
def read_user_me(
 db: Session = Depends(get_db),
 current_user: DBUser = Depends(get_current_active_user),
):
 """
 Get current user
 Get current user.
 """
 return current_user


@router.post("/users/open", tags=["users"], response_model=User)
@router.post("/open", response_model=User)
def create_user_open(
 *,
 db: Session = Depends(get_db),
Expand All@@ -98,7 +98,7 @@ def create_user_open(
 full_name: str = Body(None),
):
 """
 Create new user without the need to be logged in
 Create new user without the need to be logged in.
 """
 if not config.USERS_OPEN_REGISTRATION:
 raise HTTPException(
Expand All@@ -111,19 +111,19 @@ def create_user_open(
 status_code=400,
 detail="The user with this username already exists in the system",
 )
 user_in = UserInCreate(password=password, email=email, full_name=full_name)
 user_in = UserCreate(password=password, email=email, full_name=full_name)
 user = crud.user.create(db, user_in=user_in)
 return user


@router.get("/users/{user_id}", tags=["users"], response_model=User)
@router.get("/{user_id}", response_model=User)
def read_user_by_id(
 user_id: int,
 current_user: DBUser = Depends(get_current_active_user),
 db: Session = Depends(get_db),
):
 """
 Get a specific user by id
 Get a specific user by id.
 """
 user = crud.user.get(db, user_id=user_id)
 if user == current_user:
Expand All@@ -135,19 +135,18 @@ def read_user_by_id(
 return user


@router.put("/users/{user_id}", tags=["users"], response_model=User)
@router.put("/{user_id}", response_model=User)
def update_user(
 *,
 db: Session = Depends(get_db),
 user_id: int,
 user_in: UserInUpdate,
 user_in: UserUpdate,
 current_user: UserInDB = Depends(get_current_active_superuser),
):
 """
 Update a user
 Update a user.
 """
 user = crud.user.get(db, user_id=user_id)

 if not user:
 raise HTTPException(
 status_code=404,
Expand Down

8 changes: 4 additions & 4 deletions
{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/utils.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,23 +10,23 @@
router = APIRouter()


@router.post("/test-celery/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-celery/", response_model=Msg, status_code=201)
def test_celery(
 msg: Msg, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test Celery worker
 Test Celery worker.
 """
 celery_app.send_task("app.worker.test_celery", args=[msg.msg])
 return {"msg": "Word received"}


@router.post("/test-email/", tags=["utils"], response_model=Msg, status_code=201)
@router.post("/test-email/", response_model=Msg, status_code=201)
def test_email(
 email_to: EmailStr, current_user: UserInDB = Depends(get_current_active_superuser)
):
 """
 Test emails
 Test emails.
 """
 send_test_email(email_to=email_to)
 return {"msg": "Test email sent"}

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/backend/app/app/crud/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
from . import user
from . import item, user
Loading