falco-cli 0.22.2__tar.gz → 0.22.3__tar.gz

{falco_cli-0.22.2 → falco_cli-0.22.3}/.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
           - --remove-unused-variables
 
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.12.0
+    rev: v3.13.0
     hooks:
       - id: reorder-python-imports
         args:

{falco_cli-0.22.2 → falco_cli-0.22.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: falco-cli
-Version: 0.22.2
+Version: 0.22.3
 Summary: Enhance your Django developer experience: CLI and Guides for the Modern Developer.
 Project-URL: Documentation, https://falco.oluwatobi.dev/
 Project-URL: Homepage, https://falco.oluwatobi.dev/
@@ -66,16 +66,6 @@ Falco is a Django-centric toolkit designed to enhance the development experience
 
 <!-- [![Read the full documentation](https://img.shields.io/badge/Read%20The%20full%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev) -->
 
-## Templates
-
-- [tailwind](https://github.com/Tobi-De/falco_blueprint_basic) (default)
-- [bootstrap](https://github.com/Tobi-De/falco_blueprint_basic_bootstrap)
-- [pico](https://github.com/Tobi-De/falco_blueprint_basic_pico)
-
-
-### Features
-
-
 
 ## The CLI
 
@@ -100,6 +90,13 @@ pip install falco-cli
 - [rm-migrations](https://falco.oluwatobi.dev/the_cli/migrations.html): Remove all migrations for the specified applications directory. (development only)
 - [reset-migrations](https://falco.oluwatobi.dev/the_cli/migrations.html#reset-migrations): Delete and recreate all migrations. (development only)
 
+
+**Templates**
+
+- [tailwind](https://github.com/Tobi-De/falco_blueprint_basic) (default)
+- [bootstrap](https://github.com/Tobi-De/falco_blueprint_basic_bootstrap)
+- [pico](https://github.com/Tobi-De/falco_blueprint_basic_pico)
+
 ## The guides
 
 > [!NOTE]

{falco_cli-0.22.2 → falco_cli-0.22.3}/README.md

@@ -25,16 +25,6 @@ Falco is a Django-centric toolkit designed to enhance the development experience
 
 <!-- [![Read the full documentation](https://img.shields.io/badge/Read%20The%20full%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev) -->
 
-## Templates
-
-- [tailwind](https://github.com/Tobi-De/falco_blueprint_basic) (default)
-- [bootstrap](https://github.com/Tobi-De/falco_blueprint_basic_bootstrap)
-- [pico](https://github.com/Tobi-De/falco_blueprint_basic_pico)
-
-
-### Features
-
-
 
 ## The CLI
 
@@ -59,6 +49,13 @@ pip install falco-cli
 - [rm-migrations](https://falco.oluwatobi.dev/the_cli/migrations.html): Remove all migrations for the specified applications directory. (development only)
 - [reset-migrations](https://falco.oluwatobi.dev/the_cli/migrations.html#reset-migrations): Delete and recreate all migrations. (development only)
 
+
+**Templates**
+
+- [tailwind](https://github.com/Tobi-De/falco_blueprint_basic) (default)
+- [bootstrap](https://github.com/Tobi-De/falco_blueprint_basic_bootstrap)
+- [pico](https://github.com/Tobi-De/falco_blueprint_basic_pico)
+
 ## The guides
 
 > [!NOTE]

{falco_cli-0.22.2/blueprints/falco_blueprint_basic_pico → falco_cli-0.22.3/blueprints/falco_blueprint_basic}/.github/workflows/ci.yml

@@ -3,73 +3,53 @@ name: CI
 on:
   pull_request:
     branches: ['master', 'main']
-
   push:
     branches: ['master', 'main']
-
   workflow_dispatch:
 
 jobs:
   create-project:
     runs-on: ubuntu-latest
-
     steps:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-
       - name: Install falco
-        run: |
-          pip install falco-cli --pre
-
+        run: pip install falco-cli --pre
       - name: Checkout Code Repository
         uses: actions/checkout@v4
-
       # - name: Debugging with ssh
       #   uses: lhotari/action-upterm@v1
-
       - name: Generate a project
         run: falco start-project test-project -b . --skip-new-version-check
         working-directory: ./
-
-      - name: Install hatch
-        run: |
-          pip install hatch
-
+      - name: Install Hatch
+        uses: pypa/hatch@install
+      - name: Install just
+        uses: extractions/setup-just@v2
       - name: Run django checks
-        run: |
-          cd test_project && hatch run python manage.py check --fail-level WARNING
+        run: cd test_project && just dj check --fail-level WARNING
 
   build-image:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code Repository
         uses: actions/checkout@v4
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3.0.0
-
       - name: Install falco
-        run: |
-          pip install falco-cli --pre
-
-      - name: Install hatch
-        run: |
-          pip install hatch
-
+        run: pip install falco-cli --pre
       - name: Generate a project
         run: falco start-project test-project -b . --skip-new-version-check
         working-directory: ./
-
+      - name: Install Hatch
+        uses: pypa/hatch@install
+      - name: Install just
+        uses: extractions/setup-just@v2
       - name: Generate requirements.txt
-        run: |
-          cd test_project
-          hatch run python --version
-
+        run: cd test_project && just bootstrap
       - name: Build image
-        run: |
-          cd test_project
-          docker build . -f deploy/Dockerfile
+        run: cd test_project && rm .env && docker build . -f deploy/Dockerfile
 
 

falco_cli-0.22.3/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ["master", "main"]
+    paths-ignore: ["docs/**"]
+
+  push:
+    branches: ["master", "main"]
+    paths-ignore: ["docs/**"]
+
+  workflow_dispatch:
+
+concurrency:
+  group: {% raw %}${{ github.head_ref || github.run_id }}{% endraw %}
+  cancel-in-progress: true
+
+jobs:
+  types:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Hatch
+        uses: pypa/hatch@install
+      - name: Install just
+        uses: extractions/setup-just@v2
+      - name: Run type checking
+        run: just types
+
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Hatch
+        uses: pypa/hatch@install
+      - name: Install just
+        uses: extractions/setup-just@v2
+      - name: Run deployment checks
+        run: just deploy-checks
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Hatch
+        uses: pypa/hatch@install
+      - name: Install just
+        uses: extractions/setup-just@v2
+      - name: Build staticfiles
+        run: |
+          just manage tailwind --skip-checks build
+          just manage collectstatic --no-input --skip-checks
+          just manage compress
+      - name: Test with pytest
+        run: just test

{falco_cli-0.22.2 → falco_cli-0.22.3}/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
       - id: check-json
 
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.12.0
+    rev: v3.13.0
     hooks:
       - id: reorder-python-imports
         args:
@@ -31,13 +31,13 @@ repos:
       - id: djlint-django
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: "1.17.0"
+    rev: "1.19.0"
     hooks:
     -   id: django-upgrade
         args: [--target-version, "5.0"]
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "2.1.3"
+    rev: "2.1.4"
     hooks:
       - id: pyproject-fmt
 

falco_cli-0.22.3/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/README.md

@@ -0,0 +1,34 @@
+# {{ cookiecutter.project_name }}
+
+[![falco](https://img.shields.io/badge/built%20with-falco-success)](https://github.com/Tobi-De/falco)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+
+## Prerequisites
+
+- `Python 3.11+`
+- [hatch 1.9.1+](https://hatch.pypa.io/latest/)
+- [just](https://github.com/casey/just)
+
+## Development
+
+### Setup project
+
+Ensure that the Python version specified in your `.pre-commit-config.yaml` file aligns with the Python in your virtual environment.
+Hatch can [manage your python installation](https://hatch.pypa.io/latest/tutorials/python/manage/) if needed.
+If this is a newly created project, run `git init && git add -A` first.
+
+```shell
+just setup
+```
+Read the content of the justfile to understand what this command does. Essentially, it sets up your virtual environment, 
+installs the dependencies, runs migrations, and creates a superuser with the credentials `admin@localhost` (email) and `admin` (password).
+
+### Run the django development server
+
+```shell
+just server
+```
+
+> [!TIP]
+> Run `just` to see all available commands.

{falco_cli-0.22.2 → falco_cli-0.22.3}/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/deploy/Dockerfile

@@ -32,7 +32,6 @@ RUN tar -C /s6-install -Jxpf /tmp/s6-overlay-noarch.tar.xz
 RUN tar -C /s6-install -Jxpf /tmp/s6-overlay-x86_64.tar.xz
 
 # Build static files
-ENV DEBUG=True
 COPY . /app
 WORKDIR /app
 RUN python manage.py tailwind build

falco_cli-0.22.3/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/justfile

@@ -0,0 +1,157 @@
+{% raw %}set dotenv-load := true
+
+# List all available commands
+_default:
+    @just --list --unsorted
+
+# ----------------------------------------------------------------------
+# DEPENDENCIES
+# ----------------------------------------------------------------------
+
+# Bootstrap local development environment
+@bootstrap:
+    hatch env create
+    hatch env create dev
+    hatch env create docs
+    just install
+
+# Setup local environnment (maybe install hatch and setup postgres (create database, etc..))
+@setup:
+    just bootstrap
+    just cmd pre-commit install --install-hooks
+    just migrate
+    just createsuperuser
+    just lint
+
+# Install dependencies
+@install *ARGS:
+    just cmd python --version
+
+# Generate and upgrade dependencies
+@upgrade:
+    just cmd hatch-pip-compile --upgrade
+    just cmd hatch-pip-compile dev --upgrade
+
+# Clean up local development environment
+@clean:
+    hatch env prune
+    rm -f .coverage.*
+
+# ----------------------------------------------------------------------
+# TESTING/TYPES
+# ----------------------------------------------------------------------
+
+# Run the test suite, generate code coverage, and export html report
+@coverage-html: test
+    rm -rf htmlcov
+    @just cmd python -m coverage html --skip-covered --skip-empty
+
+# Run the test suite, generate code coverage, and print report to stdout
+coverage-report: test
+    @just cmd python -m coverage report
+
+# Run tests using pytest
+@test *ARGS:
+    just cmd coverage run -m pytest {{ ARGS }}
+
+# Run mypy on project
+@types:
+    just cmd python -m mypy .
+
+# Run the django deployment checks
+@deploy-checks:
+    just dj check --deploy
+
+# ----------------------------------------------------------------------
+# DJANGO
+# ----------------------------------------------------------------------
+
+# Run a falco command
+@falco *COMMAND:
+    just cmd falco {{ COMMAND }}
+
+# Run a django management command
+@dj *COMMAND:
+    just cmd python -m manage {{ COMMAND }}
+
+# Run the django development server
+@server:
+    just falco work
+
+# Open a Django shell using django-extensions shell_plus command
+@shell:
+    just dj shell_plus
+
+alias mm := makemigrations
+
+# Generate Django migrations
+@makemigrations *APPS:
+    just dj makemigrations {{ APPS }}
+
+# Run Django migrations
+@migrate *ARGS:
+    just dj migrate {{ ARGS }}
+
+# Reset the database
+@reset-db:
+    just dj reset_db --noinput
+
+alias su := createsuperuser
+
+# Quickly create a superuser with the provided credentials
+createsuperuser EMAIL="admin@localhost" PASSWORD="admin":
+    @export DJANGO_SUPERUSER_PASSWORD='{{ PASSWORD }}' && just dj createsuperuser --noinput --email "{{ EMAIL }}"
+
+# Generate admin code for a django app
+@admin APP:
+    just dj admin_generator {{ APP }} | tail -n +2 > {% endraw %}{{ cookiecutter.project_name }}{% raw %}/{{ APP }}/admin.py
+
+# ----------------------------------------------------------------------
+# DOCS
+# ----------------------------------------------------------------------
+
+# Build documentation using Sphinx
+@docs-build LOCATION="docs/_build/html":
+    sphinx-build docs {{ LOCATION }}
+
+# Install documentation dependencies
+@docs-install:
+    hatch run docs:python --version
+
+# Serve documentation locally
+@docs-serve:
+    hatch run docs:sphinx-autobuild docs docs/_build/html --port 8001
+
+# Generate and upgrade documentation dependencies
+docs-upgrade:
+    just cmd hatch-pip-compile dev --upgrade
+
+# ----------------------------------------------------------------------
+# UTILS
+# ----------------------------------------------------------------------
+
+# Run a command within the dev environnment
+@cmd *ARGS:
+    hatch --env dev run {{ ARGS }}
+
+# Run all formatters
+@fmt:
+    just --fmt --unstable
+    hatch fmt --formatter
+    just cmd pre-commit run pyproject-fmt -a
+    just cmd pre-commit run reorder-python-imports -a
+    just cmd pre-commit run djlint-reformat-django -a
+
+# Run pre-commit on all files
+@lint:
+    -hatch --env dev run pre-commit run --all-files
+
+# Bump project version and update changelog
+@bumpver version:
+    just cmd bump-my-version bump {{ version }}
+    just cmd git-cliff --output CHANGELOG.md
+    git add -A
+    git commit --amend --no-edit
+    git push
+    git push --tags
+{% endraw %}

{falco_cli-0.22.2 → falco_cli-0.22.3}/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "{{ cookiecutter.project_name }}"
-version = "0.1.0"
+version = "0.0.1"
 description = ""
 readme = "README.md"
 authors = [{ name = "{{ cookiecutter.author_name }}", email = "{{ cookiecutter.author_email }}" }]
@@ -33,15 +33,14 @@ dependencies = [
   "django-fastdev",
   "django-htmx",
   "django-model-utils",
+  "diskcache",
   "environs[django]",
   "heroicons[django]",
   "gunicorn",
   "boto3",
   "crispy-tailwind",
-  "hiredis",
   "Pillow",
   "psycopg[binary]",
-  "redis",
   "sentry-sdk",
   "whitenoise",
 ]
@@ -90,7 +89,7 @@ worker = "python manage.py qcluster"
 
 [tool.hatch.env]
 requires = [
-  "hatch-pip-compile>=1.11.1"
+  "hatch-pip-compile>=1.11.2"
 ]
 
 [[tool.hatch.envs.all.matrix]]
@@ -101,15 +100,27 @@ type = "pip-compile"
 pip-compile-constraint = "default"
 pip-compile-installer = "uv"
 pip-compile-resolver = "uv"
-dependencies = ["dj-notebook>=0.6.1", "Werkzeug[watchdog]>=3.0.1", "pre-commit", "django-stubs[compatible-mypy]", "falco-cli"]
+lock-filename = "requirements.txt"
 
-[tool.hatch.envs.default.scripts]
-runserver = ["migrate", "python manage.py tailwind runserver {args}"]
-migrate = "python manage.py migrate {args}"
-makemigrations = "python manage.py makemigrations {args}"
-reset-db = "python manage.py reset_db --noinput"
-shell = "python manage.py shell_plus {args}"
-upgrade-deps = ["rm requirements.txt", "hatch env run --env default -- python --version"]
+[tool.hatch.envs.dev]
+dependencies = [
+    "django-browser-reload",
+    "django-debug-toolbar",
+    "dj-notebook>=0.6.1",
+    "Werkzeug[watchdog]>=3.0.1",
+    "django-stubs[compatible-mypy]",
+    "coverage[toml]>=6.5",
+    "pre-commit",
+    "pytest",
+    "pytest-django",
+    "pytest-sugar",
+    "pytest-xdist",
+    "falco-cli",
+    "django-watchfiles",
+    "git-cliff",
+    "bump-my-version",
+]
+lock-filename = "requirements-dev.txt"
 
 [tool.hatch.envs.docs]
 dependencies = [
@@ -122,25 +133,6 @@ dependencies = [
 ]
 lock-filename = "docs/requirements.txt"
 
-[tool.hatch.envs.docs.scripts]
-serve = "sphinx-autobuild docs docs/_build/html --port 8001"
-
-[tool.hatch.envs.test]
-dependencies = [
-  "coverage[toml]>=6.5",
-  "pytest",
-  "pytest-django",
-  "pytest-sugar",
-  "pytest-xdist",
-]
-lock-filename = "tests/requirements.txt"
-
-[tool.hatch.envs.test.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
-cov-report = ["- coverage combine", "coverage report"]
-cov = ["test-cov", "cov-report"]
-
 [tool.mypy]
 python_version = "3.11"
 check_untyped_defs = true
@@ -182,3 +174,79 @@ extend-ignore = ["TID252", "RUF012", "TRY003", "EM101", "I001", "I002"]
 "*/migrations/*" = ["E501"]
 "tests/**/*" = ["PLR2004", "S101", "TID252", "ARG001"]
 "docs/conf.py" = ["INP001", "A001"]
+
+[tool.bumpversion]
+current_version = "0.0.1"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = [
+  "{major}.{minor}.{patch}",
+]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+commit_args = "--no-verify"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[tool.git-cliff.changelog]
+header = {% raw %}"""
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""{% endraw %}
+footer = """
+<!-- generated by git-cliff -->
+"""
+trim = true
+
+[tool.git-cliff.git]
+conventional_commits = true
+filter_unconventional = true
+split_commits = false
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc|^docs", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^build", group = "<!-- 7 -->📦 Build" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 8 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 9 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 10 -->◀️ Revert" },
+]
+protect_breaking_commits = false
+filter_commits = false
+topo_order = false
+sort_commits = "oldest"