Tobi-De/falco

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

build-in-public
cookiecutter
cookiecutter-template
django
hatch
htmx
starter-project

falco logo

Falco

An opinionated toolkit for a modern Django development experience

CI Publish Python Package Documentation 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

All Contributors

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

Tobi DEGNON
Tobi DEGNON

💻 📖 ⚠️
Muhammad Hammad
Muhammad Hammad

🤔
mathiasag7
mathiasag7

💻
Richard Shea
Richard Shea

📖
Waqar Khan
Waqar Khan

💻
tissieres
tissieres

💵
Hsiaoming Yang
Hsiaoming Yang

🐛
Stars
326
8.28% more than last month
Forks
14
Open Issues
12