falco-cli 0.2.2__tar.gz → 0.2.4__tar.gz

{falco_cli-0.2.2 → falco_cli-0.2.4}/.all-contributorsrc

@@ -35,6 +35,24 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "shearichard",
+      "name": "Richard Shea",
+      "avatar_url": "https://avatars.githubusercontent.com/u/403435?v=4",
+      "profile": "http://mainlydata.kubadev.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "786raees",
+      "name": "Waqar Khan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/96701299?v=4",
+      "profile": "https://lexumsoft.com/",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

{falco_cli-0.2.2 → falco_cli-0.2.4}/.github/workflows/documentation.yml

@@ -15,6 +15,8 @@ jobs:
         run: |
           pip install hatch
       - name: Sphinx build
+        env:
+          SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           hatch run docs:sphinx-build docs _build
       - name: Deploy to GitHub Pages

{falco_cli-0.2.2 → falco_cli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: falco-cli
-Version: 0.2.2
+Version: 0.2.4
 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/
@@ -55,17 +55,12 @@ Description-Content-Type: text/markdown
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tobi-De/falco/blob/main/LICENSE)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/falco-cli)
 ![PyPI - Versions from Framework Classifiers](https://img.shields.io/pypi/frameworkversions/django/falco-cli)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/falco-cli)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 
-
-> [!WARNING]
-> This is a work in progress (WIP), this is also [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) new cooler brother.
-
-<!-- start-docs -->
-
 Falco is a Django-centric toolkit designed to enhance the development experience. The CLI offers commands for initiating new projects, generating simple CRUD views for rapid prototyping, and more. Additionally, it provides a collection of guides to address common issues in web development specifically tailored to Django.
 
 <!-- [![Read the full documentation](https://img.shields.io/badge/Read%20The%20full%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev) -->
@@ -146,6 +141,8 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
       <td align="center" valign="top" width="14.28%"><a href="http://oluwatobi.dev"><img src="https://avatars.githubusercontent.com/u/40334729?v=4?s=100" width="100px;" alt="Tobi DEGNON"/><br /><sub><b>Tobi DEGNON</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Code">💻</a> <a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Documentation">📖</a> <a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/hammadarshad1"><img src="https://avatars.githubusercontent.com/u/45298916?v=4?s=100" width="100px;" alt="Muhammad Hammad"/><br /><sub><b>Muhammad Hammad</b></sub></a><br /><a href="#ideas-hammadarshad1" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mathiasag7"><img src="https://avatars.githubusercontent.com/u/50689712?v=4?s=100" width="100px;" alt="mathiasag7"/><br /><sub><b>mathiasag7</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=mathiasag7" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://mainlydata.kubadev.com"><img src="https://avatars.githubusercontent.com/u/403435?v=4?s=100" width="100px;" alt="Richard Shea"/><br /><sub><b>Richard Shea</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=shearichard" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://lexumsoft.com/"><img src="https://avatars.githubusercontent.com/u/96701299?v=4?s=100" width="100px;" alt="Waqar Khan"/><br /><sub><b>Waqar Khan</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=786raees" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>
@@ -162,4 +159,3 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-<!-- end-docs -->

{falco_cli-0.2.2 → falco_cli-0.2.4}/README.md

@@ -15,17 +15,12 @@
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tobi-De/falco/blob/main/LICENSE)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/falco-cli)
 ![PyPI - Versions from Framework Classifiers](https://img.shields.io/pypi/frameworkversions/django/falco-cli)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/falco-cli)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 
-
-> [!WARNING]
-> This is a work in progress (WIP), this is also [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) new cooler brother.
-
-<!-- start-docs -->
-
 Falco is a Django-centric toolkit designed to enhance the development experience. The CLI offers commands for initiating new projects, generating simple CRUD views for rapid prototyping, and more. Additionally, it provides a collection of guides to address common issues in web development specifically tailored to Django.
 
 <!-- [![Read the full documentation](https://img.shields.io/badge/Read%20The%20full%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev) -->
@@ -106,6 +101,8 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
       <td align="center" valign="top" width="14.28%"><a href="http://oluwatobi.dev"><img src="https://avatars.githubusercontent.com/u/40334729?v=4?s=100" width="100px;" alt="Tobi DEGNON"/><br /><sub><b>Tobi DEGNON</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Code">💻</a> <a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Documentation">📖</a> <a href="https://github.com/Tobi-De/falco/commits?author=Tobi-De" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/hammadarshad1"><img src="https://avatars.githubusercontent.com/u/45298916?v=4?s=100" width="100px;" alt="Muhammad Hammad"/><br /><sub><b>Muhammad Hammad</b></sub></a><br /><a href="#ideas-hammadarshad1" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mathiasag7"><img src="https://avatars.githubusercontent.com/u/50689712?v=4?s=100" width="100px;" alt="mathiasag7"/><br /><sub><b>mathiasag7</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=mathiasag7" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://mainlydata.kubadev.com"><img src="https://avatars.githubusercontent.com/u/403435?v=4?s=100" width="100px;" alt="Richard Shea"/><br /><sub><b>Richard Shea</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=shearichard" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://lexumsoft.com/"><img src="https://avatars.githubusercontent.com/u/96701299?v=4?s=100" width="100px;" alt="Waqar Khan"/><br /><sub><b>Waqar Khan</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=786raees" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>
@@ -122,4 +119,3 @@ Falco is inspired by (and borrows elements from) some excellent open source proj
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-<!-- end-docs -->

falco_cli-0.2.4/docs/_static/custom.css

@@ -0,0 +1,8 @@
+html.light {
+    --yue-c-code-text: var(--yue-c-text);
+}
+
+html.dark {
+    --yue-c-code-text: var(--yue-c-text);
+}
+

falco_cli-0.2.4/docs/changelog.rst

@@ -0,0 +1,9 @@
+:description: falco release history
+
+Changelog
+=========
+
+.. changelog::
+    :changelog-url: https://github.com/Tobi-De/falco/releases
+    :github: https://github.com/Tobi-De/falco/releases
+    :pypi: https://pypi.org/project/falco-cli/

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/conf.py

@@ -18,6 +18,7 @@ release = version
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
+    "sphinx.ext.extlinks",
     "myst_parser",
     "sphinx_design",
     "sphinx_tabs.tabs",
@@ -25,10 +26,13 @@ extensions = [
     "sphinx_togglebutton",
     "sphinx_autorun",
     "cappa.ext.docutils",
+    "sphinx_github_changelog",
+    "sphinxcontrib.mermaid",
 ]
 extlinks = {
     "pull": ("https://github.com/tobi-de/falco/pull/%s", "pull request #%s"),
     "issue": ("https://github.com/tobi-de/falco/issues/%s", "issue #%s"),
+    "repo": ("https://github.com/tobi-de/falco", "github repository"),
 }
 
 templates_path = ["_templates"]
@@ -52,12 +56,15 @@ html_theme_options = {
     "mastodon_url": "https://fosstodon.org/@tobide",
     "github_url": "https://github.com/tobi-de/falco",
     "twitter_url": "https://twitter.com/tobidegnon",
-    "light_css_variables": {
-        "--sy-rc-theme": "77, 210, 255",
-    },
-    "dark_css_variables": {
-        "--sy-rc-theme": "0, 153, 204",
-    },
+    "accent_color": "sky",
+    "globaltoc_expand_depth": 1,
 }
 html_logo = "images/logo_with_text.svg"
 html_favicon = "../assets/falco-logo.svg"
+html_css_files = [
+    "custom.css",
+]
+
+# -- Mermaid configuration -----------------------------------------------------
+mermaid_version = "10.6.1"
+mermaid_output_format = "svg"

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/contributing.rst

@@ -111,11 +111,10 @@ Pull Request Guidelines
 Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/Tobi-De/falco/pull_requests
+2. If the pull request adds functionality, the docs should be updated. Add the
+   feature to the list in README.md.
+3. The pull request should work for Python 3.10, 3.11 and 3.12. Check
+   https://github.com/Tobi-De/falco/pulls
    and make sure that the tests pass for all supported Python versions.
 
 Tips

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/guides/deployment.rst

@@ -3,6 +3,7 @@
 Deploy your project
 ===================
 
+https://www.youtube.com/watch?v=t-wsiW5mkgA
 
 Intro
 
@@ -42,6 +43,11 @@ WSGI server
 
 **Process Managers**
 
+
+**Restart without downtime**
+sudo supervisorctl pid gunicorn | sudo xargs kill -s HUP
+https://blog.pecar.me/gunicorn-restart
+
 Web server
 ----------
 
@@ -50,6 +56,10 @@ https://www.nginx.com/products/nginx-unit/
 https://httpd.apache.org/
 https://caddyserver.com/
 
+**A small note on reverse proxies**
+
+https://traefik.io/traefik/
+
 Resources
 ---------
 

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/guides/index.rst

@@ -31,15 +31,18 @@ developer in general.
 
 **The obvious ones**
 
-.. grid:: 2
+.. grid:: 1 1 1 2
+    :class-row: surface
+    :padding: 0
+    :gutter: 2
 
-    .. grid-item-card:: The official Django documentation
+    .. grid-item-card:: :octicon:`rocket` The official Django documentation
         :link: https://docs.djangoproject.com/en/dev/
 
         Django's documentation is arguably one of the best I have encountered. The **Topics guides** and **How-to guides** are particularly
         noteworthy and should not be overlooked.
 
-    .. grid-item-card:: The HTMX documentation
+    .. grid-item-card:: :octicon:`flame` The HTMX documentation
         :link: https://htmx.org/
 
         The htmx documentation have everything you need to understand htmx but they also have great essays that are worth reading
@@ -48,24 +51,27 @@ developer in general.
 
 **Programming principles**
 
-.. grid:: 2
+.. grid:: 1 1 1 2
+    :class-row: surface
+    :padding: 0
+    :gutter: 2
 
-    .. grid-item-card:: HTML First
+    .. grid-item-card:: :octicon:`zap` HTML First
         :link: https://html-first.com/
 
         HTML First is a set of principles that aims to make building web software easier, faster, more inclusive, and more maintainable.
 
-    .. grid-item-card:: KISS
+    .. grid-item-card:: :octicon:`smiley` KISS
         :link: https://en.wikipedia.org/wiki/KISS_principle
 
         Keep it simple, stupid. This is a design principle that states that most systems work best if they are kept simple rather than made complicated.
 
-    .. grid-item-card:: WYAGNI
+    .. grid-item-card:: :octicon:`clock` WYAGNI
         :link: https://codeanthropology.substack.com/p/yagni-and-waygni?
 
         When Are You Gonna Need It? A look at how we reduce scope, what we lose along the way, and what we could gain if we didn't. With a short story from the startup trenches.
 
-    .. grid-item-card:: 12 Factor App
+    .. grid-item-card:: :octicon:`gear` 12 Factor App
         :link: https://12factor.net/
 
         The twelve-factor app is a methodology for building software-as-a-service applications. These best practices are designed to enable applications to be built with portability and resilience when deployed to the web.
@@ -73,14 +79,17 @@ developer in general.
 
 **Blog articles and videos**
 
-.. grid:: 2
+.. grid:: 1 1 1 2
+    :class-row: surface
+    :padding: 0
+    :gutter: 2
 
-    .. grid-item-card:: Adam Johnson blog
+    .. grid-item-card:: :octicon:`book` Adam Johnson blog
         :link: https://adamj.eu/tech/
 
         A core Django developer, he provides comprehensive and unique content covering every aspect of the framework.
 
-    .. grid-item-card:: BugBytes
+    .. grid-item-card:: :octicon:`video` BugBytes
         :link: https://www.youtube.com/bugbytes
 
         This is a great YouTube channel that provides a wealth of Django and HTMX content.
@@ -88,14 +97,17 @@ developer in general.
 
 **The special ones**
 
-.. grid:: 2
+.. grid:: 1 1 1 2
+    :class-row: surface
+    :padding: 0
+    :gutter: 2
 
-    .. grid-item-card:: The Grug Brained Developer
+    .. grid-item-card:: :octicon:`book` The Grug Brained Developer
         :link: https://grugbrain.dev
 
         A layman's guide to thinking like the self-aware smol brained.
 
-    .. grid-item-card:: The Cult of Done
+    .. grid-item-card:: :octicon:`shield-check` The Cult of Done
         :link: https://medium.com/@bre/the-cult-of-done-manifesto-724ca1c2ff13
 
         The cult of done manifesto is a set of principles that aims to help you get things done.

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/guides/task_queues_and_schedulers.rst

@@ -60,7 +60,7 @@ For more complex tasks, I tend to choose a solution that supports redis as a tas
     :class: dropdown
 
     If you are using one of these you might want an automatic reload feature when files changes in dev, you can use the ``hupper``
-    python package for that purpose. It watches for file changes in the cruurent directory and restarts the worker process automatically.
+    python package for that purpose. It watches for file changes in the current directory and restarts the worker process automatically.
 
     .. code-block:: bash
         :caption: usage example

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/guides/tips_and_extra.rst

@@ -19,7 +19,7 @@ Local email testing
 https://github.com/axllent/mailpit
 
 .. code-block::
-    :captions: settings.py
+    :caption: settings.py
 
     EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend",
     EMAIL_HOST = "localhost"

falco_cli-0.2.4/docs/index.rst

@@ -0,0 +1,130 @@
+:layout: landing
+:description: Falco is an opinionated toolkit for a modern Django development experience.
+
+
+.. raw:: html
+
+    <style>
+    .yue img {
+        margin-top: 0;
+        margin-bottom: 0;
+    }
+    #head {
+        display: flex;
+        align-items: center;
+        justify-content: space-between;
+        column-gap: 20px;
+    }
+
+    @media (max-width: 600px) {
+        #head {
+            flex-wrap: wrap;
+            justify-content: center;
+        }
+    }
+
+    #head h1 {
+        font-size: 4.2rem;
+        margin-top: 3.4rem;
+        margin-bottom: 1rem;
+        font-weight: 700;
+        line-height: 1.2;
+    }
+    </style>
+
+   <div id="head">
+        <img src="https://raw.githubusercontent.com/Tobi-De/falco/main/assets/falco-logo.svg" width=200 height=200>
+        <div>
+            <h1>Falco</h1>
+            <div style="display: flex; flex-wrap: wrap; gap: 10px; margin-bottom: 3em;">
+                <img src="https://github.com/Tobi-De/falco/actions/workflows/documentation.yml/badge.svg">
+                <img src="https://github.com/Tobi-De/falco/actions/workflows/ci.yml/badge.svg">
+                <img src="https://badge.fury.io/py/falco-cli.svg">
+                <img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg">
+                <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json">
+                <img src="https://img.shields.io/badge/license-MIT-blue.svg">
+                <img src="https://img.shields.io/pypi/pyversions/falco-cli">
+                <img src="https://img.shields.io/pypi/frameworkversions/django/falco-cli">
+                <img src="https://img.shields.io/pypi/dm/falco-cli">
+            </div>
+        </div>
+   </div>
+
+
+
+.. rst-class:: lead
+
+    Falco is a Django toolkit that improves development with commands for project initiation, CRUD view generation, and
+    guides addressing common web development issues tailored to Django.
+
+
+.. container:: buttons
+
+    `Docs </install.html>`_
+    `GitHub <https://github.com/tobi-de/falco>`_
+
+
+.. grid:: 1 1 2 3
+    :class-row: surface
+    :padding: 0
+    :gutter: 2
+
+    .. grid-item-card:: :octicon:`terminal` The CLI
+      :link: /the_cli/
+
+      The documentation for the falco command line interface (CLI).
+
+    .. grid-item-card:: :octicon:`book` Guides
+      :link: /guides/
+
+      A collection of guides on common web development topics and how to address them in django.
+
+    .. grid-item-card:: :octicon:`history` Changelog
+      :link: /changelog.html
+
+      Explore the latest updates and the change history of the Falco project.
+
+    .. grid-item-card:: :octicon:`comment-discussion` Discussion
+      :link: https://github.com/tobi-de/falco/discussions
+
+      Provide suggestions for improving the guides and share new ideas.
+
+    .. grid-item-card:: :octicon:`alert-fill` Issue
+      :link: https://github.com/tobi-de/falco/issues
+
+      Use this section to report bugs and request new features for the CLI.
+
+    .. grid-item-card:: :octicon:`people` Contributing
+      :link: /contributing.html
+
+      Learn how to contribute to the Falco project.
+
+-----
+
+.. raw:: html
+
+    <h2>Contributors</h2>
+
+Thanks to the following wonderful people (`emoji key <https://allcontributors.org/docs/en/emoji-key>`_) who have helped build ``falco``.
+
+.. include:: ../README.md
+    :parser: myst_parser.sphinx_
+    :start-after: <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+    :end-before: <!-- ALL-CONTRIBUTORS-LIST:END -->
+
+.. toctree::
+    :caption: Getting started
+    :hidden:
+
+    install
+    the_cli/index
+    guides/index
+
+.. toctree::
+    :caption: Development
+    :hidden:
+
+    contributing
+    codeofconduct
+    license
+    changelog

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/install.rst

@@ -13,14 +13,17 @@ Falco is available on PyPI and can be installed with pip or your favorite Python
 Next Up
 -------
 
-.. grid:: 2
+.. grid:: 1 1 1 2
+    :class-row: surface
+    :gutter: 2
+    :padding: 0
 
-    .. grid-item-card:: The CLI
+    .. grid-item-card:: :octicon:`terminal` The CLI
       :link: /the_cli/
 
       The documentation for the ``falco`` command line interface (CLI).
 
-    .. grid-item-card:: Guides
+    .. grid-item-card:: :octicon:`book` Guides
       :link: /guides/
 
       A collection of guides on common web development topics and how to address them in django.

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/the_cli/crud.rst

@@ -10,7 +10,7 @@ crud
 
 This command generates htmx-powered create, read, update, and delete views for your model. It follows a similar idea
 as `neapolitan <https://github.com/carltongibson/neapolitan>`_, but with a completely different approach. Instead of inheriting
-from a class as done with `neapolitan`, this command generates basic `views`, `urls`, and HTML `templates`, and updates or overrides the
+from a class as you would with ``neapolitan``, this command generates basic ``views``, ``urls``, and HTML ``templates``, and updates or overrides the
 corresponding files in your project. I prefer this approach because, at the end, you'll have all the new code directly in front of you. It's easily
 accessible and you can update it as you see fit. The idea is to accelerate project prototyping. Write a model and you instantly have views ready for it.
 
@@ -19,28 +19,28 @@ accessible and you can update it as you see fit. The idea is to accelerate proje
     :class: hint dropdown
 
     I think class-based views get complex faster than function-based views. Both have their use cases, but function-based views
-    stay simpler to manage longer in my experience. There is an excellent document on the topic, read this `django views the right way <https://spookylukey.github.io/django-views-the-right-way/>`_.
+    stay simpler to manage longer in my experience. There is an excellent document on the topic, read `django views the right way <https://spookylukey.github.io/django-views-the-right-way/>`_.
 
-If you want to see an example of the generated code, check out the `source code of the demo project <https://github.com/Tobi-De/falco/tree/main/demo/products.>`_.
+If you want to see an example of the generated code, check out the `source code of the demo project <https://github.com/Tobi-De/falco/tree/main/demo/demo/products>`_.
 
 Python code
 ^^^^^^^^^^^
 
 All Python code added by this command will be in **append** mode, meaning it won't override the content of your existing files.
 Instead, it will add code at the end or create the files if they are missing. The files that will be modified
-are ``forms.py``, ``urls.py``, and ``views.py``. For brevity, I'll only show an example of what the `urls.py` file
+are ``forms.py``, ``urls.py``, and ``views.py``. For brevity, I'll only show an example of what the ``urls.py`` file
 might look like for a model named ``Product`` in a django app named ``products``.
 
 .. code-block::bash
 
     falco crud product.products
 
-.. literalinclude:: ../../demo/products/urls.py
+.. literalinclude:: ../../demo/demo/products/urls.py
 
 As you can see, the convention is quite simple: ``<model_name_lower>_<operation>``. Note that if you don't specify the model name and run
 ``falco crud products``, the same code with the described conventions will be generated for all the models in the ``products`` app.
-Now, if you're anything like me, the code above might have made you cringe due to the excessive repetitions of the term ``product``.
-This wouldn't have been the case if the model was called `Category`, for example. For these specific cases, there is an ``--entry-point`` option.
+Now, if you're anything like me, the code above might have made you cringe due to the excessive repetitions of the word ``product``.
+This wouldn't have been the case if the model was called ``Category``, for example. For these specific cases, there is an ``--entry-point`` option.
 
 Let's try it.
 
@@ -66,7 +66,7 @@ Let's try it.
     ]
 
 Much cleaner, specifying that option means you consider the ``Product`` model as the entry point of your ``products`` app.
-So, instead of the base URL of the app looking like "products/products/", it will just be "products/", assuming you registered your URLs in
+So, instead of the base URL of the app looking like ``products/products/``, it will just be ``products/``, assuming you registered your URLs in
 your root URL config like this:
 
 .. code-block:: python
@@ -99,7 +99,7 @@ Four files are generated:
 * ``<model_name_lower>_update.html``
 
 There is no ``<model_name_lower>_delete.html`` file because deletion is handled in the ``<model_name_lower>_list.html``.
-Each generated HTML file expects to extend from a ``base.html`` template. Therefore, make sure you have a top-level ``base.html`` file in
+Each generated HTML file extends a ``base.html`` template. Therefore, make sure you have a top-level ``base.html`` file in
 your templates directory.
 
 

falco_cli-0.2.4/docs/the_cli/index.rst

@@ -0,0 +1,36 @@
+The CLI
+=======
+
+The falco CLI is included with the package installation. It provides a set of commands that I hope will be useful to you throughout the
+lifecycle of your project, from project setup to deployment.
+
+.. note::
+
+    If you encounter any issues or unexpected behavior with the CLI, please report it on
+    `GitHub <https://github.com/tobi-de/falco/discussions>`_.
+
+
+The entrypoint for the CLI is the ``falco`` command. It is used to execute all other subcommands.
+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.__main__.Falco
+
+.. toctree::
+   :hidden:
+
+   start_project
+   crud
+   htmx
+   work
+   migrations
+   sync_dotenv
+   make_superuser

{falco_cli-0.2.2 → falco_cli-0.2.4}/docs/the_cli/migrations.rst

@@ -14,8 +14,8 @@ It is a good idea to delete all migrations and recreate them from scratch when d
 This ensures a clean base without any remnants of testing or experimentation from the initial development phase. Even during development,
 when exploring new ideas, it is often necessary to delete all migrations and start over. This command is designed for these scenarios,
 as it deletes all migrations in your project.
-The command checks the debug value of your project using the `manage.py` file. If the debug value is set to ``False``, the command will fail.
-It takes an optional argument, `apps_dir`, which specifies the directory containing your apps. If no argument is provided, it assumes that the apps
+The command checks the debug value of your project using the ``manage.py`` file. If the debug value is set to ``False``, the command will fail.
+It takes an optional argument, ``apps_dir``, which specifies the directory containing your apps. If no argument is provided, it assumes that the apps
 directory has the same name as the current parent directory. For example, if your project is named ``my_awesome_project``, the command will assume that
 the apps directory is a subdirectory with the same name, i.e., ``my_awesome_project/my_awesome_project``. This is the default project layout created
 by the `falco startproject </the_cli/start_project.html>`_ command.
@@ -33,8 +33,8 @@ by the `falco startproject </the_cli/start_project.html>`_ command.
    This command will delete all your migrations files, be sure to commit your changes before running this command.
 
 After deleting all your migrations, your next step might likely be to reset your database using a command like ``reset-db``
-from `django-extensions <https://django-extensions.readthedocs.io/en/latest/>`. However, if you want to preserve your data,
-then the following command might be a better option than running `rm-migrations` altogether.
+from `django-extensions <https://django-extensions.readthedocs.io/en/latest/>`_. However, if you want to preserve your data,
+then the following command might be a better option than running ``rm-migrations`` altogether.
 
 reset-migrations
 ----------------
@@ -58,7 +58,7 @@ This command works exactly like the ``rm-migration`` command but goes a bit furt
 
 The `migrate fake <https://docs.djangoproject.com/en/5.0/ref/django-admin/#cmdoption-migrate-fake>`_ command apply migrations without running
 the actual SQL.
-Since the ``reset-migrations`` depends on the `rm-migrations` command, it performs the same checks: it checks your Django ``DEBUG`` value and your Git
-repo needs to be in a clean state unless you use the ``skip-git-check`` option.
+Since the ``reset-migrations`` depends on the ``rm-migrations`` command, it performs the same checks: it checks your Django ``DEBUG`` value and your Git
+repo needs to be in a clean state unless you use the ``--skip-git-check`` option.
 
-This command allows you to restore your migrations to their initial state without losing any existing data
+This command allows you to restore your migrations to their initial state without losing any existing data.