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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. {falco_cli-0.26.2 → falco_cli-0.26.3}/PKG-INFO +1 -1
  2. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/index.rst +1 -9
  3. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/index.rst +1 -1
  4. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/usage.rst +6 -12
  5. {falco_cli-0.26.2 → falco_cli-0.26.3}/justfile +11 -12
  6. {falco_cli-0.26.2 → falco_cli-0.26.3}/pyproject.toml +1 -1
  7. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/__about__.py +1 -1
  8. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/__main__.py +2 -2
  9. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/conftest.py +2 -2
  10. {falco_cli-0.26.2 → falco_cli-0.26.3}/.all-contributorsrc +0 -0
  11. {falco_cli-0.26.2 → falco_cli-0.26.3}/.editorconfig +0 -0
  12. {falco_cli-0.26.2 → falco_cli-0.26.3}/.github/workflows/ci.yml +0 -0
  13. {falco_cli-0.26.2 → falco_cli-0.26.3}/.github/workflows/pre-commit-auto-update.yml +0 -0
  14. {falco_cli-0.26.2 → falco_cli-0.26.3}/.github/workflows/publish.yml +0 -0
  15. {falco_cli-0.26.2 → falco_cli-0.26.3}/.gitignore +0 -0
  16. {falco_cli-0.26.2 → falco_cli-0.26.3}/.gitmodules +0 -0
  17. {falco_cli-0.26.2 → falco_cli-0.26.3}/.pre-commit-config.yaml +0 -0
  18. {falco_cli-0.26.2 → falco_cli-0.26.3}/.readthedocs.yaml +0 -0
  19. {falco_cli-0.26.2 → falco_cli-0.26.3}/.vscode/settings.json +0 -0
  20. {falco_cli-0.26.2 → falco_cli-0.26.3}/CODE_OF_CONDUCT.md +0 -0
  21. {falco_cli-0.26.2 → falco_cli-0.26.3}/LICENSE +0 -0
  22. {falco_cli-0.26.2 → falco_cli-0.26.3}/README.md +0 -0
  23. {falco_cli-0.26.2 → falco_cli-0.26.3}/all-contributorsrc +0 -0
  24. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/.rich-codex.yml +0 -0
  25. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/Makefile +0 -0
  26. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/add-og-title-to-home.js +0 -0
  27. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/custom.css +0 -0
  28. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/deployment.png +0 -0
  29. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/falco-logo.png +0 -0
  30. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/falco-logo.svg +0 -0
  31. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/logo_with_text.svg +0 -0
  32. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/og-image.jpg +0 -0
  33. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/entry_model.py +0 -0
  34. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/tree-1.txt +0 -0
  35. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/tree-2.txt +0 -0
  36. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/tree-3.txt +0 -0
  37. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/types.py +0 -0
  38. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/urls.py +0 -0
  39. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/snippets/utils.py +0 -0
  40. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_static/task_queue.png +0 -0
  41. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_templates/components/nav-versions.html +0 -0
  42. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_templates/sidebars/buy-me-a-coffee.html +0 -0
  43. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/_templates/sidebars/consulting.html +0 -0
  44. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/changelog.rst +0 -0
  45. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/codeofconduct.rst +0 -0
  46. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/conf.py +0 -0
  47. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/contributing.rst +0 -0
  48. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/avoiding_god_models.rst +0 -0
  49. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/database_tips.rst +0 -0
  50. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/deployment.rst +0 -0
  51. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/dynamic_model_schema.rst +0 -0
  52. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/index.rst +0 -0
  53. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/interactive_user_interfaces.rst +0 -0
  54. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/logging_and_monitoring.rst +0 -0
  55. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/multitenancy.rst +0 -0
  56. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/optimizing_database_access.rst +0 -0
  57. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/permissions_and_authorization.rst +0 -0
  58. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/realtime.rst +0 -0
  59. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/running_project_in_a_container.rst +0 -0
  60. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/task_queues_and_schedulers.rst +0 -0
  61. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/tips_and_extra.rst +0 -0
  62. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/use_sqlite_in_production.rst +0 -0
  63. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/writing_async_code.rst +0 -0
  64. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/writing_documentation.rst +0 -0
  65. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/guides/writing_tests.rst +0 -0
  66. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/index.rst +0 -0
  67. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/install.rst +0 -0
  68. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/license.rst +0 -0
  69. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/make.bat +0 -0
  70. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/requirements.txt +0 -0
  71. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/crud.rst +0 -0
  72. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/htmx.rst +0 -0
  73. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/migrations.rst +0 -0
  74. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_app.rst +0 -0
  75. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/dependency.rst +0 -0
  76. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/deploy.rst +0 -0
  77. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/issues.rst +0 -0
  78. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/packages.rst +0 -0
  79. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/start_project/structure.rst +0 -0
  80. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/sync_dotenv.rst +0 -0
  81. {falco_cli-0.26.2 → falco_cli-0.26.3}/docs/the_cli/work.rst +0 -0
  82. {falco_cli-0.26.2 → falco_cli-0.26.3}/requirements.txt +0 -0
  83. {falco_cli-0.26.2 → falco_cli-0.26.3}/scripts/update_readme_guides.py +0 -0
  84. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/__init__.py +0 -0
  85. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/checks.py +0 -0
  86. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/__init__.py +0 -0
  87. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/crud/__init__.py +0 -0
  88. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/crud/model_crud.py +0 -0
  89. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/crud/utils.py +0 -0
  90. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/htmx.py +0 -0
  91. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/htmx_extension.py +0 -0
  92. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/reset_migrations.py +0 -0
  93. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/rm_migrations.py +0 -0
  94. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/start_app.py +0 -0
  95. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/start_project.py +1 -1
  96. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/sync_dotenv.py +0 -0
  97. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/update_project.py +0 -0
  98. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/commands/work.py +0 -0
  99. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/config.py +0 -0
  100. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/html/create.html.jinja +0 -0
  101. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/html/detail.html.jinja +0 -0
  102. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/html/list.html.jinja +0 -0
  103. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/html/update.html.jinja +0 -0
  104. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/python/forms.py.jinja +0 -0
  105. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/crud/python/views.py.jinja +0 -0
  106. {falco_cli-0.26.2 → falco_cli-0.26.3}/src/falco_cli/utils.py +1 -1
  107. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/__init__.py +0 -0
  108. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_crud.py +0 -0
  109. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_htmx.py +0 -0
  110. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_htmx_extension.py +0 -0
  111. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_reset_migrations.py +0 -0
  112. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_rm_migrations.py +0 -0
  113. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_start_app.py +0 -0
  114. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_start_project.py +0 -0
  115. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_sync_dotenv.py +0 -0
  116. {falco_cli-0.26.2 → falco_cli-0.26.3}/tests/commands/test_work.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: falco-cli
3
- Version: 0.26.2
3
+ Version: 0.26.3
4
4
  Summary: Enhance your Django developer experience: CLI and Guides for the Modern Developer.
5
5
  Project-URL: Documentation, https://falco.oluwatobi.dev/
6
6
  Project-URL: Homepage, https://falco.oluwatobi.dev/
@@ -16,15 +16,7 @@ The entrypoint for the CLI is the ``falco`` command. It is used to execute all o
16
16
  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.
17
17
  Additionally, these commands require acces to your virtual environment, so make sure to activate it before executing any command.
18
18
 
19
-
20
- .. important::
21
-
22
- There is a known issue where certain commands, which depend on your Django project environment to work, such as the ``work`` or the
23
- ``crud`` commands, might occasionally fail to run. The exact cause of this issue is not entirely clear at the moment, and I've
24
- 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.
25
- This should resolve the issue.
26
-
27
- .. cappa:: falco_cli.__main__.FalcoCLI
19
+ .. cappa:: falco_cli.__main__.Falco
28
20
 
29
21
  .. toctree::
30
22
  :hidden:
@@ -23,7 +23,7 @@ can still bring you value.
23
23
 
24
24
  .. code-block:: shell
25
25
 
26
- falco start-project myproject -b boostrap
26
+ falco start-project myproject -b bootstrap
27
27
 
28
28
 
29
29
  .. note::
@@ -23,13 +23,7 @@ Each **entry** represents a journal entry within the **myjourney** app.
23
23
 
24
24
  falco start-project myjourney && cd myjourney
25
25
 
26
- **2. Initialize a new git repository and add all the new files**
27
-
28
- .. code-block:: bash
29
-
30
- git init && git add -A
31
-
32
- **3. Project setup**
26
+ **2. Project setup**
33
27
 
34
28
  Refer to the ``justfile`` in the root of the project to understand the available commands. The command below sets up your
35
29
  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
42
36
  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),
43
37
  you have a fully functional ready to deploy django project. If you update the content of the home page, your browser will automatically reload.
44
38
 
45
- **4. Create the new app, entries**
39
+ **3. Create the new app, entries**
46
40
 
47
41
  .. code-block:: bash
48
42
 
49
43
  just falco start-app entries
50
44
 
51
- **5. Add some fields to your Entry model**
45
+ **4. Add some fields to your Entry model**
52
46
 
53
47
  .. literalinclude:: /_static/snippets/entry_model.py
54
48
 
55
- **6. Make migrations for the new model and run them**
49
+ **5. Make migrations for the new model and run them**
56
50
 
57
51
  .. code-block:: bash
58
52
 
@@ -72,7 +66,7 @@ you have a fully functional ready to deploy django project. If you update the co
72
66
  [tool.falco.crud]
73
67
  always-migrate = true
74
68
 
75
- **7. Generate CRUD views for the Entry model**
69
+ **6. Generate CRUD views for the Entry model**
76
70
 
77
71
  .. code-block:: bash
78
72
 
@@ -80,7 +74,7 @@ you have a fully functional ready to deploy django project. If you update the co
80
74
 
81
75
  Without the ``--skip-git-check`` option, the command will fail since we currently have some uncommitted changes in our repository.
82
76
 
83
- **8. Run the project**
77
+ **7. Run the project**
84
78
 
85
79
  .. code-block:: bash
86
80
 
@@ -83,7 +83,7 @@ submodule-init:
83
83
  # Checkout all submodules on main
84
84
  checkout:
85
85
  #!/usr/bin/env sh
86
- for parent_dir in blueprints packages; do
86
+ for parent_dir in blueprints; do
87
87
  for dir in $parent_dir/*; do
88
88
  if [ -d "$dir" ]; then
89
89
  echo "$(basename $dir)"
@@ -98,7 +98,7 @@ checkout:
98
98
  pull:
99
99
  #!/usr/bin/env sh
100
100
  git pull
101
- for parent_dir in blueprints packages; do
101
+ for parent_dir in blueprints; do
102
102
  for dir in $parent_dir/*; do
103
103
  if [ -d "$dir" ]; then
104
104
  echo "$(basename $dir)"
@@ -113,7 +113,7 @@ pull:
113
113
  fetch:
114
114
  #!/usr/bin/env sh
115
115
  git fetch --all
116
- for parent_dir in blueprints packages; do
116
+ for parent_dir in blueprints; do
117
117
  for dir in $parent_dir/*; do
118
118
  if [ -d "$dir" ]; then
119
119
  echo "$(basename $dir)"
@@ -138,13 +138,12 @@ merge:
138
138
  # Push all changes in all submodules
139
139
  push:
140
140
  #!/usr/bin/env sh
141
- for parent_dir in blueprints packages; do
142
- for dir in $parent_dir/*; do
143
- if [ -d "$dir" ]; then
144
- echo "$(basename $dir)"
145
- cd "$dir"
146
- git pull
147
- git push
148
- cd -
149
- fi
141
+ for dir in blueprints/*; do
142
+ if [ -d "$dir" ]; then
143
+ echo "$(basename $dir)"
144
+ cd "$dir"
145
+ git pull
146
+ git push
147
+ cd -
148
+ fi
150
149
  done
@@ -209,7 +209,7 @@ source_pkgs = [
209
209
  allow_dirty = false
210
210
  commit = true
211
211
  commit_args = "--no-verify"
212
- current_version = "0.26.2"
212
+ current_version = "0.26.3"
213
213
  ignore_missing_files = false
214
214
  ignore_missing_version = false
215
215
  message = "Bump version: {current_version} → {new_version}"
@@ -1,4 +1,4 @@
1
1
  # SPDX-FileCopyrightText: 2023-present Tobi DEGNON <tobidegnon@proton.me>
2
2
  #
3
3
  # SPDX-License-Identifier: MIT
4
- __version__ = "0.26.2"
4
+ __version__ = "0.26.3"
@@ -14,7 +14,7 @@ from falco_cli.commands import Work
14
14
  @cappa.command(
15
15
  help="Enhance your Django developer experience: CLI and Guides for the Modern Django Developer.",
16
16
  )
17
- class FalcoCLI:
17
+ class Falco:
18
18
  subcommand: cappa.Subcommands[
19
19
  StartProject
20
20
  | UpdateProject
@@ -30,7 +30,7 @@ class FalcoCLI:
30
30
 
31
31
 
32
32
  def main():
33
- cappa.invoke(FalcoCLI)
33
+ cappa.invoke(Falco)
34
34
 
35
35
 
36
36
  if __name__ == "__main__":
@@ -7,7 +7,7 @@ from unittest.mock import patch
7
7
 
8
8
  import pytest
9
9
  from cappa.testing import CommandRunner
10
- from falco_cli.__main__ import FalcoCLI
10
+ from falco_cli.__main__ import Falco
11
11
 
12
12
 
13
13
  @pytest.fixture(autouse=True)
@@ -17,7 +17,7 @@ def change_test_dir(monkeypatch, tmp_path):
17
17
 
18
18
  @pytest.fixture
19
19
  def runner():
20
- return CommandRunner(FalcoCLI)
20
+ return CommandRunner(Falco)
21
21
 
22
22
 
23
23
  toolbox = Path(__file__).parent.parent / "packages" / "toolbox/src/falco_toolbox"
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -15,11 +15,11 @@ from cookiecutter.main import cookiecutter
15
15
  from falco_cli.commands.crud.utils import run_html_formatters
16
16
  from falco_cli.config import write_falco_config
17
17
  from falco_cli.utils import clean_project_name
18
+ from falco_cli.utils import get_username
18
19
  from falco_cli.utils import is_new_falco_cli_available
19
20
  from falco_cli.utils import RICH_INFO_MARKER
20
21
  from falco_cli.utils import RICH_SUCCESS_MARKER
21
22
  from falco_cli.utils import simple_progress
22
- from falco_cli.utils import get_username
23
23
  from rich import print as rich_print
24
24
  from rich.prompt import Prompt
25
25
 
@@ -1,6 +1,6 @@
1
1
  import ast
2
- import os
3
2
  import inspect
3
+ import os
4
4
  import subprocess
5
5
  from collections.abc import Callable
6
6
  from contextlib import contextmanager
File without changes