Skip to main content

Enhance your Django developer experience: CLI and Guides for the Modern Developer.

Project description

falco logo

Falco

An opinionated toolkit for a modern Django development experience

Documentation Publish Python Package pypi Hatch project Ruff MIT License PyPI - Python Version PyPI - Versions from Framework Classifiers PyPI - Downloads

[!WARNING] The falco CLI isn't stable at the moment; stability is expected with the 1.0.0 release. I'm still making numerous changes quite frequently. If you're currently using it, remember to run pip install --upgrade falco-cli from time to time.

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.

The CLI

This is a set of commands to help you throughout the lifecycle of your django project development, from bootstrapping a new project using modern tools like htmx, hatch, tailwindcss, to generating CRUD views for your models and a few utilities that might help during deployment.

For a brief introduction to the user experience of the CLI, visit this page.

pip install falco-cli
  • start-project: Initialize a new django project the falco way.
  • start-app: Initialize a new django app the falco way.
  • crud: Generate CRUD (Create, Read, Update, Delete) views for a model.
  • install-crud-utils: Install utils necessary for CRUD views.
  • work: Run all the services required to run your django project in parallel with a single command. (development only)
  • htmx: Download a local copy of the latest version of htmx.
  • htmx-ext: Download one of htmx extensions.
  • sync-dotenv: Synchronize the .env file with the .env.template file.
  • rm-migrations: Remove all migrations for the specified applications directory. (development only)
  • reset-migrations: Delete and recreate all migrations. (development only)

Templates

The guides

[!NOTE] These are currently a work in progress. Most of them are half-written or not written at all. I hope to get them in a usable state by the end of january 2024 as soon as I can. To receive updates subscribe to this discussion or follow me on x or mastodon

If you don't find any use of the CLI, I hope you will in these guides. This is a collection of guides that address common issues in web development, specifically tailored to Django. Each guide provides solutions, patterns, and approaches that are relevant to Django projects. It is similar to the Django topic guides, but instead of focusing on components of the framework like forms, models, views, etc., it focuses on more general topics like task queues, deployment, realtime, etc.

Acknowledgements

Falco is inspired by (and borrows elements from) some excellent open source projects:

Contributors

Thanks to the following wonderful people emoji key who have helped build falco.

All Contributors

Tobi DEGNON
Tobi DEGNON

💻 📖 ⚠️
Muhammad Hammad
Muhammad Hammad

🤔
mathiasag7
mathiasag7

💻
Richard Shea
Richard Shea

📖
Waqar Khan
Waqar Khan

💻
tissieres
tissieres

💵

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

falco_cli-0.18.6.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

falco_cli-0.18.6-py3-none-any.whl (34.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page