rafsaf · rafsaf · Feb 4, 2023 · Feb 4, 2023 · Feb 4, 2023 · Feb 4, 2023
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -26,31 +26,28 @@ jobs:
         with:
           python-version: "3.10"
 
-      - name: Generate projects from templates using cookiecutter
-        # fastapi_users_project folder
-        # minimal_project folder
+      # Below will create fresh template in path: minimal_project
+      - name: Generate project from template using cookiecutter
         run: |
           pip install cookiecutter
           python tests/create_minimal_project.py
-          python tests/create_fastapi_users_project.py
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
           virtualenvs-create: true
           virtualenvs-in-project: true
 
-      ### template minimal ###
-
-      - name: Load cached venv-1
-        id: cached-poetry-dependencies-template-1
+      # run tests from folder minimal_project
+      - name: Load cached venv
+        id: cached-poetry-dependencies-template
         uses: actions/cache@v2
         with:
           path: minimal_project/.venv
           key: venv-${{ runner.os }}-${{ hashFiles('minimal_project/poetry.lock') }}
 
       - name: Install template minimal dependencies
-        if: steps.cached-poetry-dependencies-template-1.outputs.cache-hit != 'true'
+        if: steps.cached-poetry-dependencies-template.outputs.cache-hit != 'true'
         run: |
           cd minimal_project
           poetry install --no-interaction --no-root
@@ -66,30 +63,3 @@ jobs:
           cd minimal_project
           poetry run flake8 app --count --exit-zero --statistics
           poetry run coverage run -m pytest
-
-      ### template fastapi users ###
-
-      - name: Load cached venv-2
-        id: cached-poetry-dependencies-template-2
-        uses: actions/cache@v2
-        with:
-          path: fastapi_users_project/.venv
-          key: venv-${{ runner.os }}-${{ hashFiles('fastapi_users_project/poetry.lock') }}
-
-      - name: Install template fastapi users dependencies
-        if: steps.cached-poetry-dependencies-template-1.outputs.cache-hit != 'true'
-        run: |
-          cd fastapi_users_project
-          poetry install --no-interaction --no-root
-
-      - name: Run template fastapi users flake8 and then tests
-        env:
-          TEST_DATABASE_HOSTNAME: localhost
-          TEST_DATABASE_PASSWORD: postgres
-          TEST_DATABASE_PORT: 5432
-          TEST_DATABASE_USER: postgres
-          TEST_DATABASE_DB: postgres
-        run: |
-          cd fastapi_users_project
-          poetry run flake8 app --count --exit-zero --statistics
-          poetry run coverage run -m pytest
diff --git a/README.md b/README.md
@@ -54,20 +54,18 @@ _Check out also online example: https://minimal-fastapi-postgres-template.rafsaf
 
 ## Quickstart
 
-
 ### 1. Install cookiecutter globally and cookiecutter this project
+
 ```bash
 pip install cookiecutter
 
 # And cookiecutter this project :)
 cookiecutter https://github.com/rafsaf/minimal-fastapi-postgres-template
 
-# if you want experimental fastapi-users template
-# check "experimental_fastapi_users_template"
-# to True in cookiecutter option
 ```
 
 ### 2. Install dependecies with poetry or without it
+
 ```bash
 cd project_name
 ### Poetry install (python3.10)
@@ -78,24 +76,28 @@ python3.10 -m venv venv
 source venv/bin/activate
 pip install -r requirements-dev.txt
 ```
+
 Note, be sure to use `python3.10` with this template with either poetry or standard venv & pip, if you need to stick to some earlier python version, you should adapt it yourself (remove python3.10+ specific syntax for example `str | int`)
 
 ### 3. Setup databases
+
 ```bash
 ### Setup two databases
 docker-compose up -d
 
 ### Alembic migrations upgrade and initial_data.py script
 bash init.sh
 ```
+
 ### 4. Now you can run app
+
 ```bash
 ### And this is it:
 uvicorn app.main:app --reload
 
 ```
-You should then use `git init` to initialize git repository and access OpenAPI spec at http://localhost:8000/ by default. To customize docs url, cors and allowed hosts settings, read section about it.
 
+You should then use `git init` to initialize git repository and access OpenAPI spec at http://localhost:8000/ by default. To customize docs url, cors and allowed hosts settings, read section about it.
 
 ### Running tests
 
@@ -388,36 +390,36 @@ There are some **opinionated** default settings in `/app/main.py` for documentat
 
 1. Docs
 
-    ```python
-    app = FastAPI(
-        title=config.settings.PROJECT_NAME,
-        version=config.settings.VERSION,
-        description=config.settings.DESCRIPTION,
-        openapi_url="/openapi.json",
-        docs_url="/",
-    )
-    ```
-    Docs page is simpy `/` (by default in FastAPI it is `/docs`). Title, version and description are taken directly from `config` and then directly from `pyproject.toml` file. You can change it completely for the project, remove or use environment variables `PROJECT_NAME`, `VERSION`, `DESCRIPTION`.
-
-2. CORS 
-
-    ```python
-    app.add_middleware(
-        CORSMiddleware,
-        allow_origins=[str(origin) for origin in config.settings.BACKEND_CORS_ORIGINS],
-        allow_credentials=True,
-        allow_methods=["*"],
-        allow_headers=["*"],
-    )
-    ```
+   ```python
+   app = FastAPI(
+       title=config.settings.PROJECT_NAME,
+       version=config.settings.VERSION,
+       description=config.settings.DESCRIPTION,
+       openapi_url="/openapi.json",
+       docs_url="/",
+   )
+   ```
 
-    If you are not sure what are CORS for, follow https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS. React and most frontend frameworks nowadays operate on `localhost:3000` thats why it's included in `BACKEND_CORS_ORIGINS` in .env file, before going production be sure to include and frontend domain here, like `my-fontend-app.example.com`
+   Docs page is simpy `/` (by default in FastAPI it is `/docs`). Title, version and description are taken directly from `config` and then directly from `pyproject.toml` file. You can change it completely for the project, remove or use environment variables `PROJECT_NAME`, `VERSION`, `DESCRIPTION`.
 
-3. Allowed Hosts
+2. CORS
 
-    ```python
-    app.add_middleware(TrustedHostMiddleware, allowed_hosts=config.settings.ALLOWED_HOSTS)
-    ```
+   ```python
+   app.add_middleware(
+       CORSMiddleware,
+       allow_origins=[str(origin) for origin in config.settings.BACKEND_CORS_ORIGINS],
+       allow_credentials=True,
+       allow_methods=["*"],
+       allow_headers=["*"],
+   )
+   ```
+
+   If you are not sure what are CORS for, follow https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS. React and most frontend frameworks nowadays operate on `localhost:3000` thats why it's included in `BACKEND_CORS_ORIGINS` in .env file, before going production be sure to include and frontend domain here, like `my-fontend-app.example.com`
+
+3. Allowed Hosts
 
-    Prevents HTTP Host Headers attack, you shoud put here you server IP or (preferably) full domain under it's accessible like `example.com`. By default in .env there are two most popular records: `ALLOWED_HOSTS=["localhost", "127.0.0.1"]`
+   ```python
+   app.add_middleware(TrustedHostMiddleware, allowed_hosts=config.settings.ALLOWED_HOSTS)
+   ```
 
+   Prevents HTTP Host Headers attack, you shoud put here you server IP or (preferably) full domain under it's accessible like `example.com`. By default in .env there are two most popular records: `ALLOWED_HOSTS=["localhost", "127.0.0.1"]`
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -1,4 +1,3 @@
 {
-  "project_name": "my_project_name",
-  "experimental_fastapi_users_template": false
+  "project_name": "my_project_name"
 }
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -1,26 +1,10 @@
 """
-Copy template choosen from TEMPLATES to main folder.
-
 Copy content from env template (autogenerated passwords etc) 
 to .env which is gitignored, then remove template env file as it is redundant.
 """
 from pathlib import Path
-from shutil import copytree, rmtree
 
 PROJECT_NAME = "{{ cookiecutter.project_name }}"
-USE_FASTAPI_USERS = "{{ cookiecutter.experimental_fastapi_users_template }}"
-TEMPLATES = ["template_fastapi_users", "template_minimal"]
-
-
-def copy_choosen_template_to_main_dir(used_template: str):
-    if used_template not in TEMPLATES:
-        raise ValueError(f"{used_template} not in {TEMPLATES}")
-
-    copytree(used_template, "./", dirs_exist_ok=True)
-
-    for template in TEMPLATES:
-        rmtree(Path(template))
-
 
 def create_env_file_and_remove_env_template():
     env_template_file = Path(".env.template")
@@ -31,14 +15,4 @@ def create_env_file_and_remove_env_template():
 
 
 if __name__ == "__main__":
-    truthy = ["T", "t", "true", "True", 1]
-    falsy = ["F", "f", "false", "False", 0]
-    if USE_FASTAPI_USERS in truthy:
-        used_template = "template_fastapi_users"
-    elif USE_FASTAPI_USERS in falsy:
-        used_template = "template_minimal"
-    else:
-        raise ValueError(f"'experimental_fastapi_users_template' param must be in {truthy + falsy}")
-
-    copy_choosen_template_to_main_dir(used_template=used_template)
     create_env_file_and_remove_env_template()
diff --git a/tests/create_fastapi_users_project.py b/tests/create_fastapi_users_project.py
diff --git a/tests/create_minimal_project.py b/tests/create_minimal_project.py
@@ -15,7 +15,6 @@ def main():
         no_input=True,
         extra_context={
             "project_name": "minimal_project",
-            "experimental_fastapi_users_template": False,
         },
     )
 

diff --git a/...ject_name}}/template_minimal/.env.example → {{cookiecutter.project_name}}/.env.example b/...ject_name}}/template_minimal/.env.example → {{cookiecutter.project_name}}/.env.example
diff --git a/...ect_name}}/template_minimal/.env.template → {{cookiecutter.project_name}}/.env.template b/...ect_name}}/template_minimal/.env.template → {{cookiecutter.project_name}}/.env.template
diff --git a/...ect_name}}/template_fastapi_users/.flake8 → {{cookiecutter.project_name}}/.flake8 b/...ect_name}}/template_fastapi_users/.flake8 → {{cookiecutter.project_name}}/.flake8
diff --git a/..._name}}/template_fastapi_users/.gitignore → {{cookiecutter.project_name}}/.gitignore b/..._name}}/template_fastapi_users/.gitignore → {{cookiecutter.project_name}}/.gitignore
diff --git a/...roject_name}}/template_minimal/Dockerfile → {{cookiecutter.project_name}}/Dockerfile b/...roject_name}}/template_minimal/Dockerfile → {{cookiecutter.project_name}}/Dockerfile
diff --git a/...oject_name}}/template_minimal/alembic.ini → {{cookiecutter.project_name}}/alembic.ini b/...oject_name}}/template_minimal/alembic.ini → {{cookiecutter.project_name}}/alembic.ini
diff --git a/...e}}/template_fastapi_users/alembic/README → {{cookiecutter.project_name}}/alembic/README b/...e}}/template_fastapi_users/alembic/README → {{cookiecutter.project_name}}/alembic/README
diff --git a/...ct_name}}/template_minimal/alembic/env.py → {{cookiecutter.project_name}}/alembic/env.py b/...ct_name}}/template_minimal/alembic/env.py → {{cookiecutter.project_name}}/alembic/env.py
diff --git a/...late_fastapi_users/alembic/script.py.mako → ...ter.project_name}}/alembic/script.py.mako b/...late_fastapi_users/alembic/script.py.mako → ...ter.project_name}}/alembic/script.py.mako
diff --git a/...022050745_init_user_model_d1252175c146.py → ...022050745_init_user_model_d1252175c146.py b/...022050745_init_user_model_d1252175c146.py → ...022050745_init_user_model_d1252175c146.py
diff --git a/...}}/template_fastapi_users/app/__init__.py → ...okiecutter.project_name}}/app/__init__.py b/...}}/template_fastapi_users/app/__init__.py → ...okiecutter.project_name}}/app/__init__.py
diff --git a/...emplate_fastapi_users/app/api/__init__.py → ...cutter.project_name}}/app/api/__init__.py b/...emplate_fastapi_users/app/api/__init__.py → ...cutter.project_name}}/app/api/__init__.py
diff --git a/...ct_name}}/template_minimal/app/api/api.py → {{cookiecutter.project_name}}/app/api/api.py b/...ct_name}}/template_minimal/app/api/api.py → {{cookiecutter.project_name}}/app/api/api.py
diff --git a/...t_name}}/template_minimal/app/api/deps.py → ...okiecutter.project_name}}/app/api/deps.py b/...t_name}}/template_minimal/app/api/deps.py → ...okiecutter.project_name}}/app/api/deps.py
diff --git a/...stapi_users/app/api/endpoints/__init__.py → ...ject_name}}/app/api/endpoints/__init__.py b/...stapi_users/app/api/endpoints/__init__.py → ...ject_name}}/app/api/endpoints/__init__.py
diff --git a/...emplate_minimal/app/api/endpoints/auth.py → ....project_name}}/app/api/endpoints/auth.py b/...emplate_minimal/app/api/endpoints/auth.py → ....project_name}}/app/api/endpoints/auth.py
diff --git a/...mplate_minimal/app/api/endpoints/users.py → ...project_name}}/app/api/endpoints/users.py b/...mplate_minimal/app/api/endpoints/users.py → ...project_name}}/app/api/endpoints/users.py
diff --git a/...}}/template_fastapi_users/app/conftest.py → ...okiecutter.project_name}}/app/conftest.py b/...}}/template_fastapi_users/app/conftest.py → ...okiecutter.project_name}}/app/conftest.py
diff --git a/...mplate_fastapi_users/app/core/__init__.py → ...utter.project_name}}/app/core/__init__.py b/...mplate_fastapi_users/app/core/__init__.py → ...utter.project_name}}/app/core/__init__.py
diff --git a/...ame}}/template_minimal/app/core/config.py → ...ecutter.project_name}}/app/core/config.py b/...ame}}/template_minimal/app/core/config.py → ...ecutter.project_name}}/app/core/config.py
diff --git a/...e}}/template_minimal/app/core/security.py → ...utter.project_name}}/app/core/security.py b/...e}}/template_minimal/app/core/security.py → ...utter.project_name}}/app/core/security.py
diff --git a/...me}}/template_minimal/app/core/session.py → ...cutter.project_name}}/app/core/session.py b/...me}}/template_minimal/app/core/session.py → ...cutter.project_name}}/app/core/session.py
diff --git a/...me}}/template_minimal/app/initial_data.py → ...cutter.project_name}}/app/initial_data.py b/...me}}/template_minimal/app/initial_data.py → ...cutter.project_name}}/app/initial_data.py
diff --git a/...oject_name}}/template_minimal/app/main.py → {{cookiecutter.project_name}}/app/main.py b/...oject_name}}/template_minimal/app/main.py → {{cookiecutter.project_name}}/app/main.py
diff --git a/...ect_name}}/template_minimal/app/models.py → {{cookiecutter.project_name}}/app/models.py b/...ect_name}}/template_minimal/app/models.py → {{cookiecutter.project_name}}/app/models.py
diff --git a/...plate_fastapi_users/app/tests/__init__.py → ...er.project_name}}/app/schemas/__init__.py b/...plate_fastapi_users/app/tests/__init__.py → ...er.project_name}}/app/schemas/__init__.py
diff --git a/.../template_minimal/app/schemas/requests.py → ...er.project_name}}/app/schemas/requests.py b/.../template_minimal/app/schemas/requests.py → ...er.project_name}}/app/schemas/requests.py
diff --git a/...template_minimal/app/schemas/responses.py → ...r.project_name}}/app/schemas/responses.py b/...template_minimal/app/schemas/responses.py → ...r.project_name}}/app/schemas/responses.py
diff --git a/...t_name}}/template_minimal/app/__init__.py → ...tter.project_name}}/app/tests/__init__.py b/...t_name}}/template_minimal/app/__init__.py → ...tter.project_name}}/app/tests/__init__.py
diff --git a/...}}/template_minimal/app/tests/conftest.py → ...tter.project_name}}/app/tests/conftest.py b/...}}/template_minimal/app/tests/conftest.py → ...tter.project_name}}/app/tests/conftest.py
diff --git a/...}/template_minimal/app/tests/test_auth.py → ...ter.project_name}}/app/tests/test_auth.py b/...}/template_minimal/app/tests/test_auth.py → ...ter.project_name}}/app/tests/test_auth.py
diff --git a/.../template_minimal/app/tests/test_users.py → ...er.project_name}}/app/tests/test_users.py b/.../template_minimal/app/tests/test_users.py → ...er.project_name}}/app/tests/test_users.py
diff --git a/...}/template_minimal/docker-compose.dev.yml → ...ter.project_name}}/docker-compose.dev.yml b/...}/template_minimal/docker-compose.dev.yml → ...ter.project_name}}/docker-compose.dev.yml
diff --git a/...ame}}/template_minimal/docker-compose.yml → ...ecutter.project_name}}/docker-compose.yml b/...ame}}/template_minimal/docker-compose.yml → ...ecutter.project_name}}/docker-compose.yml
diff --git a/...ect_name}}/template_fastapi_users/init.sh → {{cookiecutter.project_name}}/init.sh b/...ect_name}}/template_fastapi_users/init.sh → {{cookiecutter.project_name}}/init.sh
diff --git a/...}/template_minimal/nginx-unit-config.json → ...ter.project_name}}/nginx-unit-config.json b/...}/template_minimal/nginx-unit-config.json → ...ter.project_name}}/nginx-unit-config.json
diff --git a/...oject_name}}/template_minimal/poetry.lock → {{cookiecutter.project_name}}/poetry.lock b/...oject_name}}/template_minimal/poetry.lock → {{cookiecutter.project_name}}/poetry.lock
diff --git a/...name}}/template_fastapi_users/pre-push.sh → {{cookiecutter.project_name}}/pre-push.sh b/...name}}/template_fastapi_users/pre-push.sh → {{cookiecutter.project_name}}/pre-push.sh
diff --git a/...ct_name}}/template_minimal/pyproject.toml → {{cookiecutter.project_name}}/pyproject.toml b/...ct_name}}/template_minimal/pyproject.toml → {{cookiecutter.project_name}}/pyproject.toml
diff --git a/...e}}/template_minimal/requirements-dev.txt → ...utter.project_name}}/requirements-dev.txt b/...e}}/template_minimal/requirements-dev.txt → ...utter.project_name}}/requirements-dev.txt
diff --git a/..._name}}/template_minimal/requirements.txt → ...kiecutter.project_name}}/requirements.txt b/..._name}}/template_minimal/requirements.txt → ...kiecutter.project_name}}/requirements.txt
diff --git a/{{cookiecutter.project_name}}/template_fastapi_users/.env.example b/{{cookiecutter.project_name}}/template_fastapi_users/.env.example
diff --git a/{{cookiecutter.project_name}}/template_fastapi_users/.env.template b/{{cookiecutter.project_name}}/template_fastapi_users/.env.template
diff --git a/{{cookiecutter.project_name}}/template_fastapi_users/Dockerfile b/{{cookiecutter.project_name}}/template_fastapi_users/Dockerfile