Initial commit - fastapi-mvc/fastapi-mvc#146

Author: rszamszur

.gitignore

@@ -0,0 +1,34 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+flake8_code_errors.txt
+pep257_violations.txt
+pep8_violations.txt
+code_complexity.txt
+xunit-*.xml
+
+# PyCharm
+.idea
+
+# virtual
+venv
+.venv
+
+# direnv
+.direnv

cookiecutter.json

@@ -0,0 +1,32 @@
+{
+  "project_name": "{{ cookiecutter.project_name }}",
+  "folder_name": "{{ cookiecutter.project_name|lower|replace(' ','-') }}",
+  "repo_url": "{{ cookiecutter.repo_url }}",
+  "package_name": "{{ cookiecutter.project_name|lower|replace(' ','_')|replace('-','_') }}",
+  "docker_image_name": "{{ cookiecutter.project_name|lower|replace(' ','_') }}",
+  "script_name": "{{ cookiecutter.project_name|lower|replace(' ','_') }}",
+  "chart_name": "{{ cookiecutter.project_name|lower|replace(' ','-') }}",
+  "author": "{{ cookiecutter.author }}",
+  "email": "{{ cookiecutter.email }}",
+  "project_description": "This project was generated with fastapi-mvc.",
+  "version": "0.1.0",
+  "redis": ["yes", "no"],
+  "github_actions": ["yes", "no"],
+  "aiohttp": ["yes", "no"],
+  "helm": ["yes", "no"],
+  "nix": ["yes", "no"],
+  "license": [
+        "MIT",
+        "BSD2",
+        "BSD3",
+        "ISC",
+        "Apache2.0",
+        "LGPLv3+",
+        "LGPLv3",
+        "LGPLv2+",
+        "LGPLv2",
+        "no"
+  ],
+  "year": "{{ cookiecutter.year }}",
+  "fastapi_mvc_version": "{{ cookiecutter.fastapi_mvc_version }}"
+}

hooks/post_gen_project.py

@@ -0,0 +1,84 @@
+"""Fastapi-mvc cookiecutter template post_gen_project hook."""
+import os
+import shutil
+
+
+def remove(paths):
+    """Remove directories and files provided in paths list.
+
+    Args:
+        paths(list): List of relative paths to remove.
+
+    """
+    pwd = os.getcwd()
+
+    for path in paths:
+        path = os.path.join(pwd, path)
+
+        if path and os.path.exists(path):
+            if os.path.isdir(path):
+                shutil.rmtree(path)
+            else:
+                os.remove(path)
+
+
+def set_gh_actions():
+    """Remove GitHub actions if not enabled."""
+    if "{{ cookiecutter.github_actions }}" != "yes":
+        remove([".github"])
+
+
+def set_aiohttp():
+    """Remove aiohttp utility implementation and tests if not enabled."""
+    if "{{ cookiecutter.aiohttp }}" != "yes":
+        remove(
+            [
+                "{{ cookiecutter.package_name }}/app/utils/aiohttp_client.py",
+                "tests/unit/app/utils/test_aiohttp_client.py",
+            ]
+        )
+
+
+def set_helm():
+    """Remove Helm chart if not enabled."""
+    if "{{ cookiecutter.helm }}" != "yes":
+        remove(
+            [
+                "charts",
+                ".github/workflows/integration.yml",
+                "build/dev-env.sh",
+                "manifests",
+            ]
+        )
+
+
+def set_redis():
+    """Remove Redis utility implementation and tests if not enabled."""
+    if "{{ cookiecutter.redis }}" != "yes":
+        remove(
+            [
+                "manifests",
+                "{{ cookiecutter.package_name }}/app/utils/redis.py",
+                "{{ cookiecutter.package_name }}/config/redis.py",
+            ]
+        )
+
+
+def set_nix():
+    """Remove Nix expression files if not enabled."""
+    if "{{ cookiecutter.nix }}" != "yes":
+        remove(
+            [
+                "shell.nix",
+                "image.nix",
+                "default.nix",
+            ]
+        )
+
+
+if __name__ == "__main__":
+    set_gh_actions()
+    set_aiohttp()
+    set_helm()
+    set_redis()
+    set_nix()

{{cookiecutter.folder_name}}/.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    {{cookiecutter.package_name}}/config/gunicorn.py
+    {{cookiecutter.package_name}}/__main__.py

{{cookiecutter.folder_name}}/.dockerignore

@@ -0,0 +1,26 @@
+__pycache__
+*.py[cod]
+*$py.class
+*.egg-info
+.installed.cfg
+*.egg
+htmlcov
+.tox/
+.pytest_cache
+.mypy_cache
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis
+xunit-*.xml
+.idea
+venv
+.venv
+.vagrant
+.direnv
+site
+.git
+.github

{{cookiecutter.folder_name}}/.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+{%- raw %}
+name: Build Docs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Load Poetry cache
+        id: poetry-cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.POETRY_HOME }}
+          key: ${{ runner.os }}-3.9-${{ hashFiles('./pyproject.toml') }}-${{ hashFiles('./poetry.lock') }}
+      - name: Build documentation
+        run: make docs
+      - name: Archive build artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ format('docs-{0}', github.sha) }}
+          path: site
+          retention-days: 60
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/[email protected]
+        with:
+          target_branch: gh-pages
+          build_dir: site
+          commit_message: "Deploy to GitHubPages"
+          jekyll: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+{%- endraw %}

{{cookiecutter.folder_name}}/.github/workflows/integration.yml

@@ -0,0 +1,38 @@
+{% raw %}name: K8s integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  # This job checks if an identical workflow is being triggered by different
+  # event and skips it. For instance there is no need to run the same pipeline
+  # twice for pull_request and push for identical commit sha.
+  pre_job:
+    runs-on: ubuntu-latest
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/[email protected]
+        with:
+          skip_after_successful_duplicate: 'true'
+          concurrent_skipping: same_content
+          do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'
+  test:
+    needs: pre_job
+    if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
+    runs-on: macos-12
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run vagrant up
+        run: vagrant up
+      - name: Bootstrap minukube cluster and Redis operator
+        run: vagrant ssh -c "cd /syncd && make dev-env"{% endraw %}
+      - name: Test exposed {{cookiecutter.project_name}} application
+        run: vagrant ssh -c 'curl "http://{{cookiecutter.folder_name}}.$(minikube ip).nip.io/api/ready"'