falco-cli 0.3.2__tar.gz → 0.3.3b0__tar.gz

{falco_cli-0.3.2 → falco_cli-0.3.3b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: falco-cli
-Version: 0.3.2
+Version: 0.3.3b0
 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/
@@ -127,6 +127,7 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
 - [django-hatch-startproject](https://github.com/oliverandrich/django-hatch-startproject)
 - [django-unicorn](https://github.com/adamghill/django-unicorn) (Inspiration for the logo)
 - [neapolitan](https://github.com/carltongibson/neapolitan)
+- [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) (predecessor of falco)
 
 ## Contributors
 <!-- contributors:start -->

{falco_cli-0.3.2 → falco_cli-0.3.3b0}/README.md

@@ -87,6 +87,7 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
 - [django-hatch-startproject](https://github.com/oliverandrich/django-hatch-startproject)
 - [django-unicorn](https://github.com/adamghill/django-unicorn) (Inspiration for the logo)
 - [neapolitan](https://github.com/carltongibson/neapolitan)
+- [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) (predecessor of falco)
 
 ## Contributors
 <!-- contributors:start -->

falco_cli-0.3.3b0/blueprints/falco_blueprint_basic/.git

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

falco_cli-0.3.3b0/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.3.3b0/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.3.3b0/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.3.3b0/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.3.3b0/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.3.3b0/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

falco_cli-0.3.3b0/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.3.3b0/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.3.3b0/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.3.3b0/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.3.3b0/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()

falco_cli-0.3.3b0/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/config/settings.py

@@ -0,0 +1,215 @@
+import os
+from pathlib import Path
+
+import environ
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+APPS_DIR = BASE_DIR / "{{ cookiecutter.project_name }}"
+
+env = environ.Env()
+environ.Env.read_env(BASE_DIR / ".env")
+
+DJANGO_ENV = env.str("DJANGO_ENV", "dev")
+SECRET_KEY = env.str("DJANGO_SECRET_KEY")
+DEBUG = env.bool("DJANGO_DEBUG", default=False)
+ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS")
+
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = "UTC"
+USE_I18N = True
+
+DJANGO_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django.contrib.humanize",
+]
+
+THIRD_PARTY_APPS = [
+    "allauth",
+    "allauth.account",
+    "allauth.socialaccount",
+    "crispy_forms",
+    "crispy_tailwind",
+    "django_htmx",
+    "template_partials",
+    "django_tailwind_cli",
+    "django_extensions",
+    "django_browser_reload",
+    "debug_toolbar",
+    "django_fastdev",
+]
+
+LOCAL_APPS = [
+    "{{ cookiecutter.project_name }}.core",
+    "{{ cookiecutter.project_name }}.users",
+]
+
+INSTALLED_APPS = LOCAL_APPS + THIRD_PARTY_APPS + DJANGO_APPS
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "allauth.account.middleware.AccountMiddleware",
+    "django_htmx.middleware.HtmxMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
+    "django_browser_reload.middleware.BrowserReloadMiddleware",
+]
+
+INTERNAL_IPS = ["127.0.0.1", "10.0.2.2"]
+
+DEBUG_TOOLBAR_CONFIG = {
+    "DISABLE_PANELS": ["debug_toolbar.panels.redirects.RedirectsPanel"],
+    "SHOW_TEMPLATE_CONTEXT": True,
+    "ROOT_TAG_EXTRA_ATTRS": "hx-preserve",
+}
+
+ROOT_URLCONF = "config.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [str(APPS_DIR / "templates")],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+            "builtins": ["template_partials.templatetags.partials"],
+        },
+    },
+]
+
+WSGI_APPLICATION = "config.wsgi.application"
+
+DATABASES = {
+    "default": env.db(
+        "DATABASE_URL", default="postgres:///{{ cookiecutter.project_name }}"
+    )
+}
+DATABASES["default"]["ATOMIC_REQUESTS"] = True
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+STATIC_URL = "/static/"
+STATIC_ROOT = BASE_DIR / "staticfiles"
+STATICFILES_DIRS = [APPS_DIR / "static"]
+STATICFILES_FINDERS = [
+    "django.contrib.staticfiles.finders.FileSystemFinder",
+    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
+]
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
+
+MEDIA_ROOT = str(APPS_DIR / "media")
+MEDIA_URL = "/media/"
+
+AUTH_USER_MODEL = "users.User"
+
+AUTHENTICATION_BACKENDS = [
+    "django.contrib.auth.backends.ModelBackend",
+    "allauth.account.auth_backends.AuthenticationBackend",
+]
+
+LOGIN_URL = "account_login"
+
+ACCOUNT_USER_MODEL_USERNAME_FIELD = None
+ACCOUNT_USERNAME_REQUIRED = False
+ACCOUNT_AUTHENTICATION_METHOD = "email"
+ACCOUNT_EMAIL_REQUIRED = True
+ACCOUNT_EMAIL_VERIFICATION = "optional"
+ACCOUNT_FORMS = {"signup": "{{ cookiecutter.project_name }}.users.forms.UserSignupForm"}
+
+EMAIL_BACKEND = env(
+    "DJANGO_EMAIL_BACKEND",
+    default="django.core.mail.backends.console.EmailBackend",
+)
+
+CRISPY_ALLOWED_TEMPLATE_PACKS = "tailwind"
+CRISPY_TEMPLATE_PACK = "tailwind"
+
+SUPERUSER_EMAIL = env.str("DJANGO_SUPERUSER_EMAIL")
+SUPERUSER_PASSWORD = env.str("DJANGO_SUPERUSER_PASSWORD")
+
+if DJANGO_ENV == "production":
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+
+    ADMIN_URL = env.str("ADMIN_URL")
+
+    # Load cache from CACHE_URL or REDIS_URL
+    if "CACHE_URL" in os.environ:
+        CACHES = {"default": env.cache("CACHE_URL")}
+    elif "REDIS_URL" in os.environ:
+        CACHES = {"default": env.cache("REDIS_URL")}
+
+    # Security
+    CSRF_TRUSTED_ORIGINS = env.list("DJANGO_CSRF_TRUSTED_ORIGINS")
+    CSRF_COOKIE_SECURE = True
+    SESSION_COOKIE_SECURE = True
+    SECURE_BROWSER_XSS_FILTER = True
+    SECURE_CONTENT_TYPE_NOSNIFF = True
+
+    # password validation
+    AUTH_PASSWORD_VALIDATORS = [
+        {
+            "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+        },
+        {
+            "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+        },
+    ]
+
+    # HTTPS only behind a proxy that terminates SSL/TLS
+    SECURE_SSL_REDIRECT = True
+    SECURE_REDIRECT_EXEMPT = [r"^-/"]
+    SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
+    SECURE_HSTS_SECONDS = 31536000
+    SECURE_HSTS_PRELOAD = True
+    # Only set this to True if you are certain that all subdomains of your domain should be served exclusively via SSL.
+    SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool(
+        "SECURE_HSTS_INCLUDE_SUBDOMAINS", default=False
+    )
+
+    # email
+    EMAIL_BACKEND = "anymail.backends.amazon_ses.EmailBackend"
+    ANYMAIL = {
+        "AMAZON_SES_CLIENT_PARAMS": {
+            "aws_access_key_id": env.str("DJANGO_AWS_ACCESS_KEY_ID"),
+            "aws_secret_access_key": env.str("DJANGO_AWS_SECRET_ACCESS_KEY"),
+            "region_name": env.str("DJANGO_AWS_S3_REGION_NAME"),
+        }
+    }
+
+    # sentry
+    sentry_sdk.init(
+        dsn=env.url("SENTRY_DSN"),
+        integrations=[DjangoIntegration()],
+        environment=env.str("SENTRY_ENVIRONMENT", default="production"),
+        traces_sample_rate=env.float("SENTRY_TRACES_SAMPLE_RATE", default=0.0),
+        auto_session_tracking=False,
+        release="1.0.0",
+    )

falco_cli-0.3.3b0/blueprints/falco_blueprint_basic/{{ cookiecutter.project_name }}/config/urls.py

@@ -0,0 +1,19 @@
+from django.conf import settings
+from django.conf.urls.static import static
+from django.contrib import admin
+from django.urls import include
+from django.urls import path
+from django.views.generic import TemplateView
+
+urlpatterns = [
+    path("", TemplateView.as_view(template_name="home.html"), name="home"),
+    path("accounts/", include("allauth.urls")),
+    path("admin/", admin.site.urls),
+]
+
+if settings.DEBUG:
+    urlpatterns += [
+        path("__reload__/", include("django_browser_reload.urls")),
+        path("__debug__/", include("debug_toolbar.urls")),
+        *static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT),
+    ]