# Falco
**An opinionated toolkit for building web apps faster with Django**
<img align="right" width="170" height="150" src="https://raw.githubusercontent.com/Tobi-De/falco/main/docs/_static/falco-logo.svg">
[](https://github.com/Tobi-De/falco/actions/workflows/ci.yml)
[](https://github.com/Tobi-De/falco/actions/workflows/publish.yml)
[](https://beta.readthedocs.org/projects/falco-app/builds/?version=latest)
[](https://pypi.org/project/falco-app/)
[](https://github.com/pypa/hatch)
[](https://github.com/astral-sh/ruff)
[](https://github.com/Tobi-De/falco/blob/main/LICENSE)
[](https://pypi.org/project/falco-app/)
[](https://pypi.org/project/falco-app/)
[](https://pypistats.org/packages/falco-app)
Falco is an opinionated toolkit designed to speed up web app development with Django. It helps you get to production in just a few minutes while keeping your project close to the standard Django structure, keeping things simple and manageable.
## 🚀 Features
- Django 5.1 and Python 3.11 support
- Email Login via [django-allauth](https://django-allauth.readthedocs.io/en/latest/)
- Integration with `htmx` using `django-htmx`
- [CRUD View Generation](https://falco.oluwatobi.dev/the_cli/crud.html) for your models with optional integrations with `django-tables2` and `django-filters`.
- Built-in **Project Versioning** with `bump2version`, Git integration, automatic changelog updates, and GitHub release creation.
- **Automated Deployment**: Deploy your project to a VPS (using [fabric](https://www.fabfile.org/)) or Docker-based platform with ease.
- Styling with [Tailwind CSS](https://tailwindcss.com/) (including [DaisyUI](https://daisyui.com/)) or [Bootstrap](https://getbootstrap.com/).
- And much more! Check out the full list of packages [here](https://falco.oluwatobi.dev/the_cli/start_project/packages.html)
## 📚 Table of Contents
- [Falco](#falco)
- [🚀 Features](#-features)
- [📚 Table of Contents](#-table-of-contents)
- [📖 Installation](#-installation)
- [♥️ Acknowledgements](#️-acknowledgements)
- [👥 Contributors](#-contributors)
- [📜 License](#-license)
## 📖 Installation
```console
pip install falco-app
```
Read the [documentation](https://falco.oluwatobi.dev) for more information on how to use Falco.
## ♥️ Acknowledgements
Falco is inspired by (and borrows elements from) some excellent open source projects:
- [django-twc-project](https://github.com/westerveltco/django-twc-project)
- [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django)
- [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) (predecessor of falco)
- [django-hatch-startproject](https://github.com/oliverandrich/django-hatch-startproject)
- [django-unicorn](https://github.com/adamghill/django-unicorn) (Inspiration for the logo)
- [neapolitan](https://github.com/carltongibson/neapolitan)
- [django-base-site](https://github.com/epicserve/django-base-site)
- [django-cptemplate](https://github.com/softwarecrafts/django-cptemplate)
- [djangox](https://github.com/wsvincent/djangox)
## 👥 Contributors
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- contributors:start -->
Thanks to the following wonderful people [emoji key](https://allcontributors.org/docs/en/emoji-key) who have helped build `falco`.
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<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>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tissieres"><img src="https://avatars.githubusercontent.com/u/2410978?v=4?s=100" width="100px;" alt="tissieres"/><br /><sub><b>tissieres</b></sub></a><br /><a href="#financial-tissieres" title="Financial">💵</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://lepture.com"><img src="https://avatars.githubusercontent.com/u/290496?v=4?s=100" width="100px;" alt="Hsiaoming Yang"/><br /><sub><b>Hsiaoming Yang</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/issues?q=author%3Alepture" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aimedey19"><img src="https://avatars.githubusercontent.com/u/89580257?v=4?s=100" width="100px;" alt="Aimé An-Nyong DEGBEY"/><br /><sub><b>Aimé An-Nyong DEGBEY</b></sub></a><br /><a href="#ideas-aimedey19" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/earthcomfy"><img src="https://avatars.githubusercontent.com/u/66206865?v=4?s=100" width="100px;" alt="Hana Belay"/><br /><sub><b>Hana Belay</b></sub></a><br /><a href="https://github.com/Tobi-De/falco/commits?author=earthcomfy" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- contributors:end -->
## 📜 License
`falco` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "falco-app",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cookiecutter, django, project-template, python",
"author": null,
"author_email": "Tobi DEGNON <tobidegnon@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/3e/96/96953f7ab550d034667c412bb61ec98a9b24a7c1a7e20726b814815f7b23/falco_app-0.3.4.tar.gz",
"platform": null,
"description": "# Falco\n\n**An opinionated toolkit for building web apps faster with Django**\n\n<img align=\"right\" width=\"170\" height=\"150\" src=\"https://raw.githubusercontent.com/Tobi-De/falco/main/docs/_static/falco-logo.svg\">\n\n[](https://github.com/Tobi-De/falco/actions/workflows/ci.yml)\n[](https://github.com/Tobi-De/falco/actions/workflows/publish.yml)\n[](https://beta.readthedocs.org/projects/falco-app/builds/?version=latest)\n[](https://pypi.org/project/falco-app/)\n[](https://github.com/pypa/hatch)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/Tobi-De/falco/blob/main/LICENSE)\n[](https://pypi.org/project/falco-app/)\n[](https://pypi.org/project/falco-app/)\n[](https://pypistats.org/packages/falco-app)\n\nFalco is an opinionated toolkit designed to speed up web app development with Django. It helps you get to production in just a few minutes while keeping your project close to the standard Django structure, keeping things simple and manageable.\n\n\n## \ud83d\ude80 Features\n\n- Django 5.1 and Python 3.11 support\n- Email Login via [django-allauth](https://django-allauth.readthedocs.io/en/latest/)\n- Integration with `htmx` using `django-htmx`\n- [CRUD View Generation](https://falco.oluwatobi.dev/the_cli/crud.html) for your models with optional integrations with `django-tables2` and `django-filters`.\n- Built-in **Project Versioning** with `bump2version`, Git integration, automatic changelog updates, and GitHub release creation.\n- **Automated Deployment**: Deploy your project to a VPS (using [fabric](https://www.fabfile.org/)) or Docker-based platform with ease.\n- Styling with [Tailwind CSS](https://tailwindcss.com/) (including [DaisyUI](https://daisyui.com/)) or [Bootstrap](https://getbootstrap.com/).\n- And much more! Check out the full list of packages [here](https://falco.oluwatobi.dev/the_cli/start_project/packages.html)\n\n\n## \ud83d\udcda Table of Contents\n\n- [Falco](#falco)\n - [\ud83d\ude80 Features](#-features)\n - [\ud83d\udcda Table of Contents](#-table-of-contents)\n - [\ud83d\udcd6 Installation](#-installation)\n - [\u2665\ufe0f Acknowledgements](#\ufe0f-acknowledgements)\n - [\ud83d\udc65 Contributors](#-contributors)\n - [\ud83d\udcdc License](#-license)\n\n## \ud83d\udcd6 Installation\n\n```console\npip install falco-app\n```\n\nRead the [documentation](https://falco.oluwatobi.dev) for more information on how to use Falco.\n\n## \u2665\ufe0f Acknowledgements\n\nFalco is inspired by (and borrows elements from) some excellent open source projects:\n\n- [django-twc-project](https://github.com/westerveltco/django-twc-project)\n- [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django)\n- [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) (predecessor of falco)\n- [django-hatch-startproject](https://github.com/oliverandrich/django-hatch-startproject)\n- [django-unicorn](https://github.com/adamghill/django-unicorn) (Inspiration for the logo)\n- [neapolitan](https://github.com/carltongibson/neapolitan)\n- [django-base-site](https://github.com/epicserve/django-base-site)\n- [django-cptemplate](https://github.com/softwarecrafts/django-cptemplate)\n- [djangox](https://github.com/wsvincent/djangox)\n\n## \ud83d\udc65 Contributors\n\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[](#contributors-)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n<!-- contributors:start -->\nThanks to the following wonderful people [emoji key](https://allcontributors.org/docs/en/emoji-key) who have helped build `falco`.\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <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\">\ud83d\udcbb</a> <a href=\"https://github.com/Tobi-De/falco/commits?author=Tobi-De\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/Tobi-De/falco/commits?author=Tobi-De\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <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\">\ud83e\udd14</a></td>\n <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\">\ud83d\udcbb</a></td>\n <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\">\ud83d\udcd6</a></td>\n <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\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tissieres\"><img src=\"https://avatars.githubusercontent.com/u/2410978?v=4?s=100\" width=\"100px;\" alt=\"tissieres\"/><br /><sub><b>tissieres</b></sub></a><br /><a href=\"#financial-tissieres\" title=\"Financial\">\ud83d\udcb5</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://lepture.com\"><img src=\"https://avatars.githubusercontent.com/u/290496?v=4?s=100\" width=\"100px;\" alt=\"Hsiaoming Yang\"/><br /><sub><b>Hsiaoming Yang</b></sub></a><br /><a href=\"https://github.com/Tobi-De/falco/issues?q=author%3Alepture\" title=\"Bug reports\">\ud83d\udc1b</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/aimedey19\"><img src=\"https://avatars.githubusercontent.com/u/89580257?v=4?s=100\" width=\"100px;\" alt=\"Aim\u00e9 An-Nyong DEGBEY\"/><br /><sub><b>Aim\u00e9 An-Nyong DEGBEY</b></sub></a><br /><a href=\"#ideas-aimedey19\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/earthcomfy\"><img src=\"https://avatars.githubusercontent.com/u/66206865?v=4?s=100\" width=\"100px;\" alt=\"Hana Belay\"/><br /><sub><b>Hana Belay</b></sub></a><br /><a href=\"https://github.com/Tobi-De/falco/commits?author=earthcomfy\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- contributors:end -->\n\n## \ud83d\udcdc License\n\n`falco` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "Falco is a toolkit to build web apps with django faster.",
"version": "0.3.4",
"project_urls": {
"Documentation": "https://github.com/falcopackages/falco#readme",
"Issues": "https://github.com/falcopackages/falco/issues",
"Source": "https://github.com/falcopackages/falco"
},
"split_keywords": [
"cookiecutter",
" django",
" project-template",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3f73be1359a03c1fb84fcc30bff4e7ce1838155d720b248bd1930822bff67c56",
"md5": "5fc994027c9b8c0f8d7564ceffd64a5e",
"sha256": "d2a004506262ff9442af37bc94894ba1b79e8f3b2f05ebd9cf5e092914e53d32"
},
"downloads": -1,
"filename": "falco_app-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fc994027c9b8c0f8d7564ceffd64a5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 34247,
"upload_time": "2024-10-17T13:05:23",
"upload_time_iso_8601": "2024-10-17T13:05:23.565545Z",
"url": "https://files.pythonhosted.org/packages/3f/73/be1359a03c1fb84fcc30bff4e7ce1838155d720b248bd1930822bff67c56/falco_app-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e9696953f7ab550d034667c412bb61ec98a9b24a7c1a7e20726b814815f7b23",
"md5": "82bc607ebda69fabfcfe415019307667",
"sha256": "77c96f5ed2164fd1696efd67c1525d2d5625ee22f66ed3652b4b59ce260e3990"
},
"downloads": -1,
"filename": "falco_app-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "82bc607ebda69fabfcfe415019307667",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1242202,
"upload_time": "2024-10-17T13:05:21",
"upload_time_iso_8601": "2024-10-17T13:05:21.154346Z",
"url": "https://files.pythonhosted.org/packages/3e/96/96953f7ab550d034667c412bb61ec98a9b24a7c1a7e20726b814815f7b23/falco_app-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 13:05:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "falcopackages",
"github_project": "falco#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "falco-app"
}
JSON
