falco-cli 0.6.0__tar.gz → 0.6.2__tar.gz

{falco_cli-0.6.0 → falco_cli-0.6.2}/.github/workflows/documentation.yml

@@ -1,13 +1,35 @@
 name: Documentation
 
-on: [push, pull_request, workflow_dispatch]
+on: [ push, pull_request, workflow_dispatch ]
 
 permissions:
   contents: write
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12" ]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: '**/pyproject.toml'
+      - name: Install hatch
+        run: |
+          pip install hatch
+      - name: Run tests
+        run: |
+          hatch run pytest
   docs:
     runs-on: ubuntu-latest
+    needs: [test]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3

{falco_cli-0.6.0 → falco_cli-0.6.2}/.github/workflows/pre-commit-auto-update.yml

@@ -33,7 +33,7 @@ jobs:
         run: pre-commit autoupdate
 
       - name: Autoupdate generated projects
-        working-directory: "src/falco_blueprints/project_name"
+        working-directory: "."
         run: pre-commit autoupdate
 
       - name: Create Pull Request

{falco_cli-0.6.0 → falco_cli-0.6.2}/.github/workflows/publish.yml

@@ -12,6 +12,8 @@ jobs:
         python-version: ["3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: recursive
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -45,4 +47,4 @@ jobs:
       run: |
         hatch build
     - name: Publish
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1

{falco_cli-0.6.0 → falco_cli-0.6.2}/.gitignore

@@ -131,3 +131,6 @@ dmypy.json
 .DS_Store
 .idea/
 .idea/sonarlint/
+
+
+test_projects/

{falco_cli-0.6.0 → falco_cli-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: falco-cli
-Version: 0.6.0
+Version: 0.6.2
 Summary: Enhance your Django developer experience: CLI and Guides for the Modern Developer.
 Project-URL: Homepage, https://falco.oluwatobi.dev/
 Project-URL: Documentation, https://falco.oluwatobi.dev/

falco_cli-0.6.2/blueprints/falco_blueprint_basic/.git

@@ -0,0 +1 @@
+gitdir: ../../.git/modules/blueprints/falco_blueprint_basic

falco_cli-0.6.2/blueprints/falco_blueprint_basic/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ['master', 'main']
+
+  push:
+    branches: ['master', 'main']
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install falco
+        run: |
+          pip install falco-cli
+
+      - name: Generate a project
+        run: falco start-project test-project

falco_cli-0.6.2/blueprints/falco_blueprint_basic/.github/workflows/pre-commit-auto-update.yml

@@ -0,0 +1,47 @@
+# Run pre-commit autoupdate every day at midnight
+# and create a pull request if any changes
+
+name: Pre-commit auto-update
+
+on:
+  schedule:
+    - cron: "15 2 * * *"
+  workflow_dispatch: # to trigger manually
+
+permissions:
+  contents: read
+
+jobs:
+  auto-update:
+    # Disables this workflow from running in a repository that is not part of the indicated organization/user
+    if: github.repository_owner == 'Tobi-De'
+    permissions:
+      contents: write # for peter-evans/create-pull-request to create branch
+      pull-requests: write # for peter-evans/create-pull-request to create a PR
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Autoupdate template
+        run: pre-commit autoupdate
+
+      - name: Autoupdate generated projects
+        working-directory: "{{ cookiecutter.project_name }}"
+        run: pre-commit autoupdate
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: update/pre-commit-autoupdate
+          title: Auto-update pre-commit hooks
+          commit-message: Auto-update pre-commit hooks
+          body: Update versions of tools in pre-commit configs to latest version
+          labels: update

falco_cli-0.6.2/blueprints/falco_blueprint_basic/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tobi DEGNON
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

falco_cli-0.6.2/blueprints/falco_blueprint_basic/README.md

@@ -0,0 +1,10 @@
+# falco blueprint basic
+
+[![CI](https://github.com/Tobi-De/falco_blueprint_basic/actions/workflows/ci.yml/badge.svg)](https://github.com/Tobi-De/falco_blueprint_basic/actions/workflows/ci.yml)
+
+Project blueprint for https://github.com/Tobi-De/falco, run with:
+
+```shell
+pip install falco-cli
+falco start-project my_awesome_project
+```

falco_cli-0.6.2/blueprints/falco_blueprint_basic/cookiecutter.json

@@ -0,0 +1,5 @@
+{
+  "project_name": "{{ cookiecutter.project_name }}",
+  "author_name": "{{ cookiecutter.author_name }}",
+  "author_email": "{{ cookiecutter.author_name }}"
+}

falco_cli-0.6.2/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.env.template

@@ -0,0 +1,15 @@
+DJANGO_SECRET_KEY=
+DJANGO_ENV=
+DJANGO_DEBUG=
+DJANGO_ALLOWED_HOSTS=
+DATABASE_URL=
+
+ADMIN_URL=
+DJANGO_CSRF_TRUSTED_ORIGINS=
+DJANGO_AWS_ACCESS_KEY_ID=
+DJANGO_AWS_SECRET_ACCESS_KEY=
+DJANGO_AWS_S3_REGION_NAME=
+SENTRY_DSN=
+
+DJANGO_SUPERUSER_EMAIL=
+DJANGO_SUPERUSER_PASSWORD=

falco_cli-0.6.0/.github/dependabot.yml → falco_cli-0.6.2/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.github/dependabot.yml

@@ -8,4 +8,4 @@ updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "weekly"

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

@@ -0,0 +1,79 @@
+name: CI
+
+# Enable Buildkit and let compose use it to speed up image building
+env:
+  DOCKER_BUILDKIT: 1
+  COMPOSE_DOCKER_CLI_BUILD: 1
+
+on:
+  pull_request:
+    branches: ['master', 'main']
+    paths-ignore: ['docs/**']
+
+  push:
+    branches: ['master', 'main']
+    paths-ignore: ['docs/**']
+
+concurrency:
+  group: {% raw %}${{ github.head_ref || github.run_id }}{% endraw %}
+  cancel-in-progress: true
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install hatch
+        run: |
+          pip install hatch
+      - name: Create static analysis environment # this step creates the static analysis environment ahead of time to handle cases where hatch fmt fails in pre-commit
+        run: |
+          hatch fmt
+      - name: Add .env file # mypy fails without this
+        run: |
+          pip install falco-cli && falco sync-dotenv
+      - name: Run pre-commit
+        run: |
+          hatch run pre-commit run --all-files
+
+  # With no caching at all the entire ci process takes 4m 30s to complete!
+  pytest:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:15
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+
+    env:
+      # postgres://user:password@host:port/database
+      DATABASE_URL: 'postgres://postgres:postgres@localhost:5432/postgres'
+
+    steps:
+      - name: Checkout Code Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: pip
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install hatch
+        run: |
+          pip install hatch
+
+      - name: Test with pytest
+        run: hatch run test:test

falco_cli-0.6.2/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Pycharm
+.idea/

falco_cli-0.6.2/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+  python: python3.11 # TODO: change this to your virtualenv's Python version
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-symlinks
+      - id: check-json
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.12.0
+    hooks:
+      - id: reorder-python-imports
+        args:
+          - "--application-directories={{ cookiecutter.project_name }}"
+
+  - repo: https://github.com/Riverside-Healthcare/djLint
+    rev: v1.34.1
+    hooks:
+      - id: djlint-reformat-django
+      - id: djlint-django
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: "1.15.0"
+    hooks:
+    -   id: django-upgrade
+        args: [--target-version, "5.0"]
+
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: "1.6.0"
+    hooks:
+      - id: pyproject-fmt
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: Run mypy
+        entry: hatch run mypy
+        language: system
+        files: \.py$
+
+      - id: hatch fmt
+        name: run hatch fmt
+        entry: hatch fmt
+        language: system
+        files: \.py

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

@@ -0,0 +1,58 @@
+# {{ 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)
+[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)
+[![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+`
+- `Postgresql 13+`
+
+## Development
+
+### Create a new virtual environment
+
+```shell
+hatch shell
+```
+
+### Install pre-commit
+
+```shell
+git init && pre-commit install
+```
+
+Ensure that the Python version specified in your `.pre-commit-config.yaml` file aligns with the Python version installed on your system.
+
+### Create a `.env` file
+
+```shell
+falco sync-dotenv
+```
+
+### Apply migrations
+
+```shell
+hatch run migrate
+```
+
+### Create a superuser
+
+Fill the `SUPERUSER_EMAIL` and `SUPERUSER_PASSWORD` in your `.env` file and run:
+
+```shell
+falco make-superuser
+```
+
+### Run the django development server
+
+```shell
+hatch run runserver
+# if you've aliased `hatch run` to `hr``
+hr runserver
+# if you've added falco-cli as a dependency to your project
+falco work
+```

falco_cli-0.6.2/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/config/asgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+
+application = get_asgi_application()