ci: check code style and run unittest

Author: waketzheng

.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: ci
+
+on:
+  push:
+    branches: [ "main", "dev" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+    strategy:
+      matrix:
+        python-version: [3.9, "3.10", 3.11, 3.12, 3.13]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install and configure Poetry
+        run: |
+          pip install -U pip poetry
+          poetry config virtualenvs.create false
+      - name: Install dependencies
+        run: poetry install -E mysql -E postgres
+      - name: Check code style and Type Hint
+        run: fast check
+      - name: build
+        run: poetry build
+      - name: Test with pytest
+        run: fast test
+      - name: Upload Coverage
+        run: |
+          pip install --upgrade coveralls
+          coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_FLAG_NAME: ${{ matrix.python-version }}
+          COVERALLS_PARALLEL: true
+
+  coveralls:
+    name: Indicate completion to coveralls.io
+    needs: test
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+    - name: Finished
+      run: |
+        pip3 install --upgrade coveralls
+        coveralls --service=github --finish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -5,6 +5,15 @@
 
 Template for python backend project using FastAPI+TortoiseORM+poetry+aerich
 
+Inspired by [full-stack-fastapi-template](https://github.com/fastapi/full-stack-fastapi-template)
+
+## Technology Stack and Features
+
+- ⚡ [**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
+  - 🧰 [TortoiseORM](https://tortoise.github.io) for the Python SQL database interactions (ORM).
+  - 🔍 [Pydantic](https://docs.pydantic.dev), used by FastAPI, for the data validation and settings management.
+- ✅ Tests with [Pytest](https://pytest.org).
+
 ## Quickstart
 
 ```bash
@@ -15,3 +24,46 @@ poetry install
 aerich init-db
 python app.py
 ```
+
+## How To Use It
+
+You can **just fork or clone** this repository and use it as is.
+
+✨ It just works. ✨
+
+### How to Use a Private Repository
+
+If you want to have a private repository, GitHub won't allow you to simply fork it as it doesn't allow changing the visibility of forks.
+
+But you can do the following:
+
+- Create a new GitHub repo, for example `my-backend-project`.
+- Clone this repository manually, set the name with the name of the project you want to use, for example `my-backend-project`:
+
+```bash
+git clone [email protected]:waketzheng/fastapi-tortoise-poetry-template.git my-backend-project
+```
+
+- Enter into the new directory:
+
+```bash
+cd my-backend-project
+```
+
+- Set the new origin to your new repository, copy it from the GitHub interface, for example:
+
+```bash
+git remote set-url origin [email protected]:octocat/my-backend-project.git
+```
+
+- Add this repo as another "remote" to allow you to get updates later:
+
+```bash
+git remote add upstream [email protected]:waketzheng/fastapi-tortoise-poetry-template.git
+```
+
+- Push the code to your new repository:
+
+```bash
+git push -u origin master
+```

app.py

@@ -25,6 +25,7 @@ async def lifespan(application) -> AsyncGenerator:
 app = FastAPI(lifespan=lifespan)
 app.include_router(users_router, prefix="/users", tags=["users"])
 if os.getenv("FAST_CDN"):
+    # Use faster CDN host for docs page assets instead of 'cdn.jsdelivr.net'
     import fastapi_cdn_host
 
     fastapi_cdn_host.patch_docs(app)

tests/conftest.py

@@ -10,13 +10,10 @@
 try:
     from app import app
 except ImportError:
-    if (cwd := Path.cwd()) == (root := Path(__file__).parent.parent):
-        dirpath = "."
-    else:
-        dirpath = str(root.relative_to(cwd))
-    print(
-        f"You may need to explicitly declare python path:\n\nexport PYTHONPATH={dirpath}\n"
-    )
+    PYTHONPATH = "."
+    if (cwd := Path.cwd()) != (root := Path(__file__).parent.parent):
+        PYTHONPATH = str(root.relative_to(cwd))
+    print(f"You may need to explicitly declare python path:\n\nexport {PYTHONPATH=}\n")
     raise