falco-cli 0.26.2__tar.gz → 0.26.5__tar.gz

{falco_cli-0.26.2 → falco_cli-0.26.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: falco-cli
-Version: 0.26.2
+Version: 0.26.5
 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/

{falco_cli-0.26.2 → falco_cli-0.26.5}/docs/guides/deployment.rst

@@ -110,6 +110,7 @@ automatic routing, blue-green deployment, etc. It is also considered simpler to
 .. todo::
 
    Add an example of traefik config
+   Add note on ssl certificates
 
 WSGI server
 -----------

{falco_cli-0.26.2 → falco_cli-0.26.5}/docs/the_cli/index.rst

@@ -16,15 +16,7 @@ The entrypoint for the CLI is the ``falco`` command. It is used to execute all o
 Most of these commands rely on the presence of the ``manage.py`` file, so ensure that you run them from the root directory of your Django project.
 Additionally, these commands require acces to your virtual environment, so make sure to activate it before executing any command.
 
-
-.. important::
-
-    There is a known issue where certain commands, which depend on your Django project environment to work, such as the ``work`` or the
-    ``crud`` commands, might occasionally fail to run. The exact cause of this issue is not entirely clear at the moment, and I've
-    experienced it a few times myself. The simplest solution for now is to install the ``falco-cli`` in the same virtual environment as your project.
-    This should resolve the issue.
-
-.. cappa:: falco_cli.__main__.FalcoCLI
+.. cappa:: falco_cli.__main__.Falco
 
 .. toctree::
    :hidden:

{falco_cli-0.26.2 → falco_cli-0.26.5}/docs/the_cli/start_project/index.rst

@@ -23,7 +23,7 @@ can still bring you value.
 
     .. code-block:: shell
 
-        falco start-project myproject -b boostrap
+        falco start-project myproject -b bootstrap
 
 
 .. note::

{falco_cli-0.26.2 → falco_cli-0.26.5}/docs/the_cli/start_project/packages.rst

@@ -6,25 +6,51 @@ Packages and Tools
 This section provides an overview of the primary packages and tools, along with some of the design choices incorporated
 into a project generated with **Falco**.
 
+Overview
+--------
+
+System Requirements
 
 - `hatch <https://hatch.pypa.io/latest/>`_: Used for managing the project's virtual environment and dependencies, more details can be found in the `dependency management guide </guides/dependency_management.html>`_.
 - `just <https://just.system>`_: A script runner that simplifies the execution of common tasks, such as setting up the project, running the server, and running tests, run ``just`` to see all available commands.
+
+Base Dependencies
+
 - `environs <https://github.com/sloria/environs>`_: Used for configuring settings via environment variables.
 - `django-allauth <https://github.com/pennersr/django-allauth>`_: Handles login and signup processes.
-- `django-debug-toolbar <https://django-debug-toolbar.readthedocs.io/en/latest/>`_: Of course, a must.
+- `django-template-partials <https://github.com/carltongibson/django-template-partials>`_: Used for defining reusable fragments of HTML.
+- `django-htmx <https://github.com/adamchainz/django-htmx>`_: Used for making AJAX requests and updating the DOM.
+- `django-lifecycle <https://github.com/rsinger86/django-lifecycle>`_: Provides an alternative to signals for hooking into your model's lifecycle.
 - `django-heath-check <https://github.com/revsys/django-health-check>`_: Provides a ``/health`` endpoint for application, database, storage, and other health checks.
-- `django-browser-reload <https://github.com/adamchainz/django-browser-reload>`_: Automatically reloads your browser on code changes in development.
-- `django-model-utils <https://django-model-utils.readthedocs.io/en/latest/>`_: Provides useful mixins for Django models, my favorite being the ``TimeStampedModel``.
 - `django-extensions <https://django-extensions.readthedocs.io/en/latest/>`_: Adds some useful management commands to Django, such as ``shell_plus`` and ``show_urls``.
 - `django-anymail <https://github.com/anymail/django-anymail>`_: `Amazon SES <https://aws.amazon.com/ses/?nc1=h_ls>`_ is used for production email, facilitated by Anymail.
+- `django-unique-user-email <https://github.com/carltongibson/django-unique-user-email>`_: Adds a unique constraint to the email field of the Django ``User`` model.
+- `django-q2 <https://github.com/django-q2/django-q2>`_: Used for background task queue processing and scheduling.
+- `django-q-registry <https://github.com/westerveltco/django-q-registry>`_: Used for easily registering scheduled jobs.
 - `django-storages <https://django-storages.readthedocs.io/en/latest/>`_: Used for storing media files on AWS S3.
-- `django-compressor <https://django-compressor.readthedocs.io/en/latest/>`_: Compresses CSS and JavaScript files.
+- `django-compressor <https://github.com/django-compressor/django-compressor>`_: Compresses CSS and JavaScript files.
 - `refreshcss <https://github.com/adamghill/refreshcss>`_: Removes unused classes, ids, and element selectors from CSS, configured as a ``django-compressor`` filter.
 - `diskcache <https://github.com/grantjenks/python-diskcache>`_: A simple and fast cache solution based on ``sqlite3``, just add a ``LOCATION`` environnment folder for the cache location and you are good to go.
 - `Docker <https://www.docker.com/>`_ and `s6-overlay <https://github.com/just-containers/s6-overlay>`_: Docker is configured for production, with s6-overlay enabling running both the web server process (via ``gunicorn``) and the background worker process (via ``django-q2``) within a single container.
 - `Sentry <https://sentry.io/welcome/>`_: Utilized for performance and error monitoring.
 - `Whitenoise <https://whitenoise.evans.io/en/latest/>`_: Used to serve static files.
 - `heroicons <https://heroicons.com/>`_: Easy access to `heroicons <https://heroicons.com/>`_ in your Django templates.
+
+Development-Only packages
+
+- `django-debug-toolbar <https://django-debug-toolbar.readthedocs.io/en/latest/>`_: Of course, a must.
+- `django-browser-reload <https://github.com/adamchainz/django-browser-reload>`_: Automatically reloads your browser on code changes in development.
+- `django-watchfiles <https://github.com/adamchainz/django-watchfiles>`_: Faster and more efficient development server reloading.
+- `django-fastdev <https://github.com/boxed/django-fastdev>`_: Helps catch small mistakes early in your project.
+- `dj-notebook <https://github.com/pydanny/dj-notebook>`_: Allows you to use your shell_plus in a Jupyter notebook.
+- `hatch-pip-compile <https://github.com/juftin/hatch-pip-compile>`_: ``hatch`` plugin to compile requirements files.
+- `git-cliff <https://git-cliff.org/>`_: Generates a changelog based on your commit messages.
+- `bump-my-version <https://github.com/callowayproject/bump-my-version>`_: Bumps the version of your project following the `semver <https://semver.org/>`_ format.
+- `pytest <https://docs.pytest.org/en/7.0.x/>`_: Used for running tests
+- `pytest-django <https://pytest-django.readthedocs.io/en/latest/>`_: Pytest plugin for Django.
+- `pytest-sugar <https://github.com/Teemu/pytest-sugar>`_: Better looking pytest output.
+- `pytest-xdist <https://github.com/pytest-dev/pytest-xdist>`_: Run tests in parallel.
+- `Werkzeug <https://werkzeug.palletsprojects.com/en/2.1.x/>`_: Enable the Werkzeug debugger when running `manage.py runserver_plus`.
 - `pre-commit <https://github.com/pre-commit/pre-commit>`_: Integrated by default to identify simple issues before pushing code to remote.
 
 If you are using the default template, the following additional packages are included:
@@ -41,7 +67,7 @@ If you are using the Bootstrap template, the following additional packages are i
 Settings
 --------
 
-There is a single ``settings.py`` file located in your project package directory. 
+There is a single ``settings.py`` file located in your project directory. 
 
 .. code-block:: text
 
@@ -63,7 +89,7 @@ You won't even be able to set ``DEBUG=True`` in production since the development
 
 
 Login via email instead of username
-------------------------------------
+-----------------------------------
 
 The ``email`` field is configured as the login field using `django-allauth <https://github.com/pennersr/django-allauth>`_. The ``username`` field is still present
 but is not required for login. Allauth automatically fills it with the part of the email before the ``@`` symbol.

{falco_cli-0.26.2 → falco_cli-0.26.5}/docs/the_cli/usage.rst

@@ -23,13 +23,7 @@ Each **entry** represents a journal entry within the **myjourney** app.
 
     falco start-project myjourney && cd myjourney
 
-**2. Initialize a new git repository and add all the new files**
-
-.. code-block:: bash
-
-    git init && git add -A
-
-**3. Project setup**
+**2. Project setup**
 
 Refer to the ``justfile`` in the root of the project to understand the available commands. The command below sets up your
 virtual environment using ``hatch`` (default, dev, and docs), runs the project migrations, creates a superuser
@@ -42,17 +36,17 @@ with ``admin@localhost`` as the email and ``admin`` as the password, and runs pr
 At this point, you can run ``just server`` to start the project. While the UI may be basic (which I hope to improve in the future),
 you have a fully functional ready to deploy django project. If you update the content of the home page, your browser will automatically reload.
 
-**4. Create the new app, entries**
+**3. Create the new app, entries**
 
 .. code-block:: bash
 
     just falco start-app entries
 
-**5. Add some fields to your Entry model**
+**4. Add some fields to your Entry model**
 
 .. literalinclude:: /_static/snippets/entry_model.py
 
-**6.  Make migrations for the new model and run them**
+**5.  Make migrations for the new model and run them**
 
 .. code-block:: bash
 
@@ -72,7 +66,7 @@ you have a fully functional ready to deploy django project. If you update the co
         [tool.falco.crud]
         always-migrate = true
 
-**7. Generate CRUD views for the Entry model**
+**6. Generate CRUD views for the Entry model**
 
 .. code-block:: bash
 
@@ -80,7 +74,7 @@ you have a fully functional ready to deploy django project. If you update the co
 
 Without the ``--skip-git-check`` option, the command will fail since we currently have some uncommitted changes in our repository.
 
-**8. Run the project**
+**7. Run the project**
 
 .. code-block:: bash
 

{falco_cli-0.26.2 → falco_cli-0.26.5}/justfile

@@ -1,5 +1,3 @@
-default := "blueprints/falco_tailwind"
-
 # List all available commands
 _default:
     @just --list
@@ -83,7 +81,7 @@ submodule-init:
 # Checkout all submodules on main
 checkout:
     #!/usr/bin/env sh
-    for parent_dir in blueprints packages; do
+    for parent_dir in blueprints; do
       for dir in $parent_dir/*; do
         if [ -d "$dir" ]; then
           echo "$(basename $dir)"
@@ -98,7 +96,7 @@ checkout:
 pull:
     #!/usr/bin/env sh
     git pull
-    for parent_dir in blueprints packages; do
+    for parent_dir in blueprints; do
       for dir in $parent_dir/*; do
         if [ -d "$dir" ]; then
           echo "$(basename $dir)"
@@ -113,7 +111,7 @@ pull:
 fetch:
     #!/usr/bin/env sh
     git fetch --all
-    for parent_dir in blueprints packages; do
+    for parent_dir in blueprints; do
       for dir in $parent_dir/*; do
         if [ -d "$dir" ]; then
           echo "$(basename $dir)"
@@ -138,13 +136,12 @@ merge:
 # Push all changes in all submodules
 push:
     #!/usr/bin/env sh
-    for parent_dir in blueprints packages; do
-        for dir in $parent_dir/*; do
-          if [ -d "$dir" ]; then
-            echo "$(basename $dir)"
-            cd "$dir"
-            git pull
-            git push
-            cd -
-          fi
+    for dir in blueprints/*; do
+      if [ -d "$dir" ]; then
+        echo "$(basename $dir)"
+        cd "$dir"
+        git pull
+        git push
+        cd -
+      fi
     done

{falco_cli-0.26.2 → falco_cli-0.26.5}/pyproject.toml

@@ -52,6 +52,7 @@ dependencies = [
   "parso",
   "rich",
   "tomlkit",
+  "djlint",
 ]
 optional-dependencies = { just = [ "just-bin" ], hatch = [ "hatch" ] }
 
@@ -209,7 +210,7 @@ source_pkgs = [
 allow_dirty = false
 commit = true
 commit_args = "--no-verify"
-current_version = "0.26.2"
+current_version = "0.26.5"
 ignore_missing_files = false
 ignore_missing_version = false
 message = "Bump version: {current_version} → {new_version}"

{falco_cli-0.26.2 → falco_cli-0.26.5}/src/falco_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present Tobi DEGNON <tobidegnon@proton.me>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.26.2"
+__version__ = "0.26.5"

{falco_cli-0.26.2 → falco_cli-0.26.5}/src/falco_cli/__main__.py

@@ -14,7 +14,7 @@ from falco_cli.commands import Work
 @cappa.command(
     help="Enhance your Django developer experience: CLI and Guides for the Modern Django Developer.",
 )
-class FalcoCLI:
+class Falco:
     subcommand: cappa.Subcommands[
         StartProject
         | UpdateProject
@@ -30,7 +30,7 @@ class FalcoCLI:
 
 
 def main():
-    cappa.invoke(FalcoCLI)
+    cappa.invoke(Falco)
 
 
 if __name__ == "__main__":

{falco_cli-0.26.2 → falco_cli-0.26.5}/tests/conftest.py

@@ -7,7 +7,7 @@ from unittest.mock import patch
 
 import pytest
 from cappa.testing import CommandRunner
-from falco_cli.__main__ import FalcoCLI
+from falco_cli.__main__ import Falco
 
 
 @pytest.fixture(autouse=True)
@@ -17,7 +17,7 @@ def change_test_dir(monkeypatch, tmp_path):
 
 @pytest.fixture
 def runner():
-    return CommandRunner(FalcoCLI)
+    return CommandRunner(Falco)
 
 
 toolbox = Path(__file__).parent.parent / "packages" / "toolbox/src/falco_toolbox"

{falco_cli-0.26.2 → falco_cli-0.26.5}/src/falco_cli/commands/start_project.py

@@ -15,11 +15,11 @@ from cookiecutter.main import cookiecutter
 from falco_cli.commands.crud.utils import run_html_formatters
 from falco_cli.config import write_falco_config
 from falco_cli.utils import clean_project_name
+from falco_cli.utils import get_username
 from falco_cli.utils import is_new_falco_cli_available
 from falco_cli.utils import RICH_INFO_MARKER
 from falco_cli.utils import RICH_SUCCESS_MARKER
 from falco_cli.utils import simple_progress
-from falco_cli.utils import get_username
 from rich import print as rich_print
 from rich.prompt import Prompt
 

{falco_cli-0.26.2 → falco_cli-0.26.5}/src/falco_cli/utils.py

@@ -1,6 +1,6 @@
 import ast
-import os
 import inspect
+import os
 import subprocess
 from collections.abc import Callable
 from contextlib import contextmanager