Python3.9 support

.github/dependabot.yml

@@ -0,0 +1,8 @@
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 3
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
       - uses: actions/checkout@v1
@@ -42,12 +42,9 @@ jobs:
           key: pytest-${{ matrix.python-version }}
       - name: Check docs build
         # only run this for the python version used by netlify:
-        if: matrix.python-version == 3.7
+        if: matrix.python-version == 3.8
         run: |
           make docs-build-ci
       - name: Check that formatting, linting, and tests pass
         run: |
           make ci
-      - name: Submit coverage report
-        run: |
-          codecov --token=${{ secrets.CODECOV_TOKEN }}

.github/workflows/publish.yml

@@ -4,13 +4,50 @@ on:
   push
 
 jobs:
-  publish:
+  publish-master:
+    if: github.event_name == 'merge'
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      # Avoid caching to be 100% confident things are working properly
+      - name: Init python poetry action
+        uses: abatilo/[email protected]
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Check that formatting, linting, and tests pass
+        run: poetry run make ci
+
+      - name: Check docs are up to date
+        run: poetry run make docs-build-ci
+
+      - name: Build distribution
+        run: poetry build
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}  
+        # For security porpuses only!
+
+  publish-tag:
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 1
       matrix:
-        python-version: [3.7]
+        python-version: [3.8]
 
     steps:
       - uses: actions/checkout@v1
@@ -19,23 +56,24 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       # Avoid caching to be 100% confident things are working properly
+      - name: Init python poetry action
+        uses: abatilo/[email protected]
+
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
+        run: poetry install
+
       - name: Check that formatting, linting, and tests pass
-        run: |
-          make ci
+        run: poetry run make ci
+
       - name: Check docs are up to date
-        run: |
-          make docs-build-ci
-      - name: Install poetry
-        run: |
-          curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+        run: poetry run make docs-build-ci
+
       - name: Build distribution
-        run: |
-          source $HOME/.poetry/env && poetry build
+        run: poetry build
+
       - name: Publish distribution to PyPI
         uses: pypa/gh-action-pypi-publish@master
         with:
-          password: ${{ secrets.PYPI_PASSWORD }}
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}  
+        # For security porpuses only!

.github/workflows/pull-request.yml

@@ -19,6 +19,8 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Python Poetry Action
+        uses: abatilo/[email protected]
       - uses: actions/cache@v1
         id: cache-deps
         with:
@@ -27,9 +29,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
+        run: poetry install
       - uses: actions/cache@v1
         with:
           path: .mypy_cache
@@ -40,12 +40,8 @@ jobs:
           key: pytest-${{ matrix.python-version }}
       - name: Check docs build
         # only run this for the python version used by netlify:
-        if: matrix.python-version == 3.7
-        run: |
-          make docs-build-ci
+        if: matrix.python-version == 3.8
+        run: poetry run make docs-build-ci
       - name: Check that formatting, linting, and tests pass
-        run: |
-          make ci
-      - name: Submit coverage report
-        run: |
-          codecov --token=${{ secrets.CODECOV_TOKEN }}
+        run: poetry run make ci
+

CONTRIBUTING.md

@@ -4,7 +4,7 @@ First, you might want to see the basic ways to [help and get help](help-fastapi-
 
 Once you've cloned the repository, here are some guidelines to set up your environment:
 
-### Set up the development evironment
+### Set up the development environment
 
 After cloning the repository, you can use `poetry` to create a virtual environment: 
 

Makefile

@@ -1,18 +1,18 @@
 SHELL := /bin/bash
 .DEFAULT_GOAL := help
 
-pkg_src = fastapi_utils
+pkg_src = fastapi_restful
 tests_src = tests
 docs_src = docs/src
 all_src = $(pkg_src) $(tests_src)
 
-isort = isort -rc $(all_src)
+isort = isort $(all_src)
 autoflake = autoflake -r --remove-all-unused-imports --ignore-init-module-imports $(all_src)
 black = black $(all_src)
 flake8 = flake8 $(all_src)
 mypy_base = mypy --show-error-codes
 mypy = $(mypy_base) $(all_src)
-test = pytest --cov=fastapi_utils
+test = pytest --cov=$(pkg_src)
 
 .PHONY: all  ## Run the most common rules used during development
 all: static test
@@ -88,7 +88,7 @@ develop:
 .PHONY: version  ## Bump the version in both pyproject.toml and __init__.py (usage: `make version version=minor`)
 version: poetryversion
 	$(eval NEW_VERS := $(shell cat pyproject.toml | grep "^version = \"*\"" | cut -d'"' -f2))
-	@sed -i "" "s/__version__ = .*/__version__ = \"$(NEW_VERS)\"/g" $(pkg_src)/__init__.py
+	@sed -i "s/__version__ = .*/__version__ = \"$(NEW_VERS)\"/g" $(pkg_src)/__init__.py
 
 .PHONY: docs-build  ## Generate the docs and update README.md
 docs-build:

README.md

@@ -1,30 +1,31 @@
 <p align="center">
-    <em>Reusable utilities for FastAPI</em>
+    <em>Quicker FastApi developing tools</em>
 </p>
 <p align="center">
-<img src="https://img.shields.io/github/last-commit/dmontagu/fastapi-utils.svg">
-<a href="https://github.com/dmontagu/fastapi-utils" target="_blank">
-    <img src="https://github.com/dmontagu/fastapi-utils/workflows/build/badge.svg" alt="Build">
+<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
+	<img src="https://img.shields.io/github/last-commit/yuval9313/fastapi-restful.svg">
+	<img src="https://github.com/yuval9313/FastApi-RESTful/workflows/build/badge.svg" alt="Build CI">
 </a>
-<a href="https://codecov.io/gh/dmontagu/fastapi-utils" target="_blank">
-    <img src="https://codecov.io/gh/dmontagu/fastapi-utils/branch/master/graph/badge.svg" alt="Coverage">
-</a>
-<a href="https://app.netlify.com/sites/trusting-archimedes-72b369/deploys">
-    <img src="https://img.shields.io/netlify/28b2a077-65b1-4d6c-9dba-13aaf6059877" alt="Netlify status">
+<a href="https://fastapi-restful.netlify.app">
+    <img src="https://api.netlify.com/api/v1/badges/294b88e1-4b81-49c0-8525-9c4a2cb782e0/deploy-status" alt="Netlify status">
 </a>
 <br />
-<a href="https://pypi.org/project/fastapi-utils" target="_blank">
-    <img src="https://badge.fury.io/py/fastapi-utils.svg" alt="Package version">
+<a href="https://pypi.org/project/FastApi-RESTful" target="_blank">
+    <img src="https://badge.fury.io/py/fastapi-restful.svg" alt="Package version">
+</a>
+<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/FastApi-RESTful.svg" alt="Python versions">
+    <img src="https://img.shields.io/github/license/yuval9313/fastapi-utils.svg" alt="License">
 </a>
-    <img src="https://img.shields.io/pypi/pyversions/fastapi-utils.svg">
-    <img src="https://img.shields.io/github/license/dmontagu/fastapi-utils.svg">
 </p>
 
 ---
 
-**Documentation**: <a href="https://fastapi-utils.davidmontague.xyz" target="_blank">https://fastapi-utils.davidmontague.xyz</a>
+**Documentation**: <a href="https://fastapi-restful.netlify.app" target="_blank">https://fastapi-restful.netlify.app</a>
+
+**Source Code**: <a href="https://github.com/yuval9313/fastapi-restful" target="_blank">https://github.com/yuval9313/fastapi-restful</a>
 
-**Source Code**: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>
+Base on: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>
 
 ---
 
@@ -38,11 +39,12 @@ But if you're here, you probably already knew that!
 
 This package includes a number of utilities to help reduce boilerplate and reuse common functionality across projects:
 
+* **Resource Class**: Create CRUD with ease the OOP way with `Resource` base class that lets you implement methods quick.
 * **Class Based Views**: Stop repeating the same dependencies over and over in the signature of related endpoints.
 * **Response-Model Inferring Router**: Let FastAPI infer the `response_model` to use based on your return type annotation. 
 * **Repeated Tasks**: Easily trigger periodic tasks on server startup
 * **Timing Middleware**: Log basic timing information for every request
-* **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency 
+* Will be removed: **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency 
 * **OpenAPI Spec Simplification**: Simplify your OpenAPI Operation IDs for cleaner output from OpenAPI Generator
 
 ---
@@ -55,7 +57,7 @@ It also adds a variety of more basic utilities that are useful across a wide var
 * **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back
 * **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables
 
-See the [docs](https://fastapi-utils.davidmontague.xyz/) for more details and examples. 
+See the [docs](https://fastapi-restful.netlify.app/) for more details and examples. 
 
 ## Requirements
 
@@ -64,7 +66,7 @@ This package is intended for use with any recent version of FastAPI (depending o
 ## Installation
 
 ```bash
-pip install fastapi-utils
+pip install fastapi-restful
 ```
 
 ## License

docs/contributing.md

@@ -4,7 +4,7 @@ First, you might want to see the basic ways to [help and get help](help-fastapi-
 
 Once you've cloned the repository, here are some guidelines to set up your environment:
 
-### Set up the development evironment
+### Set up the development environment
 
 After cloning the repository, you can use `poetry` to create a virtual environment: 
 

docs/help-fastapi-utils.md

@@ -18,7 +18,12 @@ Adding a star will help other users find this project more easily, and see that
 
 ## Connect with the author
 
-You can connect with <a href="https://davidmontague.xyz" class="external-link" target="_blank">me (David Montague / `dmontagu`)</a>, the author of `fastapi_utils`:
+You can connect with this fork maintainer 
+<a href="https://github.com/yuval9313" class="external-link" target="_blank">on **GitHub** (`Yuval9313`)</a>.
+
+OR 
+
+You can connect with original <a href="https://davidmontague.xyz" class="external-link" target="_blank">me (David Montague / `dmontagu`)</a>, the author of `fastapi_utils`:
 
 * <a href="https://github.com/dmontagu" class="external-link" target="_blank">Follow me on **GitHub**</a>.
     * See other Open Source projects I have created that could help you.
@@ -30,7 +35,7 @@ You can connect with <a href="https://davidmontague.xyz" class="external-link" t
 
 ## Create issues
 
-You can <a href="https://github.com/dmontagu/fastapis-utils/issues/new/choose" class="external-link" target="_blank">create a new issue</a> in the GitHub repository, for example to:
+You can <a href="https://github.com/yuval9313/fastapis-utils/issues/new/choose" class="external-link" target="_blank">create a new issue</a> in the GitHub repository, for example to:
 
 * Report a bug/issue.
 * Suggest a new feature.
@@ -39,7 +44,7 @@ You can <a href="https://github.com/dmontagu/fastapis-utils/issues/new/choose" c
 
 ## Create a Pull Request
 
-You can <a href="https://github.com/dmontagu/fastapi-utils" class="external-link" target="_blank">create a Pull Request</a>, for example:
+You can <a href="https://github.com/yuval9313/fastapi-utils" class="external-link" target="_blank">create a Pull Request</a>, for example:
 
 * To fix a typo you found in the documentation.
 * To propose improvements to documentation.

docs/index.md

@@ -1,30 +1,31 @@
 <p align="center">
-    <em>Reusable utilities for FastAPI</em>
+    <em>Quicker FastApi developing tools</em>
 </p>
 <p align="center">
-<img src="https://img.shields.io/github/last-commit/dmontagu/fastapi-utils.svg">
-<a href="https://github.com/dmontagu/fastapi-utils" target="_blank">
-    <img src="https://github.com/dmontagu/fastapi-utils/workflows/build/badge.svg" alt="Build">
+<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
+	<img src="https://img.shields.io/github/last-commit/yuval9313/fastapi-restful.svg">
+	<img src="https://github.com/yuval9313/FastApi-RESTful/workflows/build/badge.svg" alt="Build CI">
 </a>
-<a href="https://codecov.io/gh/dmontagu/fastapi-utils" target="_blank">
-    <img src="https://codecov.io/gh/dmontagu/fastapi-utils/branch/master/graph/badge.svg" alt="Coverage">
-</a>
-<a href="https://app.netlify.com/sites/trusting-archimedes-72b369/deploys">
-    <img src="https://img.shields.io/netlify/28b2a077-65b1-4d6c-9dba-13aaf6059877" alt="Netlify status">
+<a href="https://fastapi-restful.netlify.app">
+    <img src="https://api.netlify.com/api/v1/badges/294b88e1-4b81-49c0-8525-9c4a2cb782e0/deploy-status" alt="Netlify status">
 </a>
 <br />
-<a href="https://pypi.org/project/fastapi-utils" target="_blank">
-    <img src="https://badge.fury.io/py/fastapi-utils.svg" alt="Package version">
+<a href="https://pypi.org/project/FastApi-RESTful" target="_blank">
+    <img src="https://badge.fury.io/py/fastapi-restful.svg" alt="Package version">
+</a>
+<a href="https://github.com/yuval9313/fastapi-restful" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/FastApi-RESTful.svg" alt="Python versions">
+    <img src="https://img.shields.io/github/license/yuval9313/fastapi-utils.svg" alt="License">
 </a>
-    <img src="https://img.shields.io/pypi/pyversions/fastapi-utils.svg">
-    <img src="https://img.shields.io/github/license/dmontagu/fastapi-utils.svg">
 </p>
 
 ---
 
-**Documentation**: <a href="https://fastapi-utils.davidmontague.xyz" target="_blank">https://fastapi-utils.davidmontague.xyz</a>
+**Documentation**: <a href="https://fastapi-restful.netlify.app" target="_blank">https://fastapi-restful.netlify.app</a>
+
+**Source Code**: <a href="https://github.com/yuval9313/fastapi-restful" target="_blank">https://github.com/yuval9313/fastapi-restful</a>
 
-**Source Code**: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>
+Base on: <a href="https://github.com/dmontagu/fastapi-utils" target="_blank">https://github.com/dmontagu/fastapi-utils</a>
 
 ---
 
@@ -38,11 +39,12 @@ But if you're here, you probably already knew that!
 
 This package includes a number of utilities to help reduce boilerplate and reuse common functionality across projects:
 
+* **Resource Class**: Create CRUD with ease the OOP way with `Resource` base class that lets you implement methods quick.
 * **Class Based Views**: Stop repeating the same dependencies over and over in the signature of related endpoints.
 * **Response-Model Inferring Router**: Let FastAPI infer the `response_model` to use based on your return type annotation. 
 * **Repeated Tasks**: Easily trigger periodic tasks on server startup
 * **Timing Middleware**: Log basic timing information for every request
-* **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency 
+* Will be removed: **SQLAlchemy Sessions**: The `FastAPISessionMaker` class provides an easily-customized SQLAlchemy Session dependency 
 * **OpenAPI Spec Simplification**: Simplify your OpenAPI Operation IDs for cleaner output from OpenAPI Generator
 
 ---
@@ -55,7 +57,7 @@ It also adds a variety of more basic utilities that are useful across a wide var
 * **CamelCase Conversions**: Convenience functions for converting strings from `snake_case` to `camelCase` or `PascalCase` and back
 * **GUID Type**: The provided GUID type makes it easy to use UUIDs as the primary keys for your database tables
 
-See the [docs](https://fastapi-utils.davidmontague.xyz/) for more details and examples. 
+See the [docs](https://fastapi-restful.netlify.app/) for more details and examples. 
 
 ## Requirements
 
@@ -64,7 +66,7 @@ This package is intended for use with any recent version of FastAPI (depending o
 ## Installation
 
 ```bash
-pip install fastapi-utils
+pip install fastapi-restful
 ```
 
 ## License