Metadata-Version: 2.4
Name: duckframework
Version: 2.3.1
Summary: Build high-performance, scalable, server-side reactive web applications — without a separate frontend framework or a complex JavaScript stack.
Author-email: Brian Musakwa <digreatbrian@gmail.com>
Maintainer-email: Brian Musakwa <digreatbrian@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Organization, https://github.com/duckframework
Project-URL: Homepage, https://duckframework.com
Project-URL: Contribution, https://duckframework.com/contribute
Project-URL: Blog, https://duckframework.com/blog
Project-URL: Documentation, https://docs.duckframework.com
Project-URL: Source, https://github.com/duckframework/duck
Project-URL: Issues, https://github.com/duckframework/duck/issues
Keywords: python,web framework,python web framework,server-side rendering,reactive web framework,reactive ui,full-stack framework,full-stack web framework,web applications,web server,http server,https,http2,http/2,websockets,real-time,async,asgi,wsgi,middleware,routing,authentication,jwt,reverse proxy,load balancer,microservices,api framework,backend framework,high performance,scalable,duck framework
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: Django>=5.1.5
Requires-Dist: Jinja2>=3.1.5
Requires-Dist: watchdog>=4.0.1
Requires-Dist: requests>=2.31.0
Requires-Dist: h2>=4.2.0
Requires-Dist: asgiref>=3.8.1
Requires-Dist: psutil>=7.0.0
Requires-Dist: msgpack>=1.1.1
Requires-Dist: rich>=14.1.0
Requires-Dist: diskcache
Requires-Dist: colorama
Requires-Dist: tzdata
Requires-Dist: click
Requires-Dist: setproctitle
Requires-Dist: pyJWT
Requires-Dist: pynacl
Requires-Dist: tomli>=2.4.1
Dynamic: license-file

# Duck Framework

**Duck Framework** is an open-source Python web framework and web server with a built-in reactive UI engine and real-time WebSocket support.

Build high-performance, scalable, server-side reactive web applications — without a separate frontend framework or a complex JavaScript stack.

[![Python >=3.10](https://img.shields.io/badge/python->=3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
[![GitHub stars](https://img.shields.io/github/stars/duckframework/duck?style=social)](https://github.com/duckframework/duck/stargazers)
[![License](https://img.shields.io/github/license/duckframework/duck)](https://github.com/duckframework/duck/blob/main/LICENSE)
[![Build Status](https://img.shields.io/github/actions/workflow/status/duckframework/duck/docs.yml?branch=main)](https://github.com/duckframework/duck/actions)

*(More badges — security, performance, integrations — on the [Features](./readme/features.md) page.)*

---

## Quickstart

```sh
# Install Duck Framework
pip install duckframework

# Create a project
duck makeproject myproject

# Change directory to myproject
cd myproject

# Run the webserver
python web/main.py # Optionally use duck runserver
```

Visit **http://localhost:8000** — you're running Duck. For the full walkthrough (install options, project types, what gets generated), see [Getting Started](./docs/getting-started.md).

---

## Documentation

New to Duck? Start with **Getting Started**, then **Understanding the Project** — that's really all you need to build your first app. The rest is there when you need it.

- 🟢 **[Getting Started](./readme/getting-started.md)** — install Duck, create a project, and start the server
- 🟢 **[Understanding the Project](./readme/understanding-the-project.md)** — what each generated file does: `main.py`, `urls.py`, views, pages, components, templates, static files
- 🔵 [Django Integration](./readme/django-integration.md) — add Duck's HTTP/2, HTTPS, and security features to an existing Django project
- 🔵 [Features](./readme/features.md) — full feature breakdown, plus what's coming next
- 🔵 [AI Guidelines](./readme/ai-guidelines.md) — using Duck with AI assistants / vibe coding
- ⚪ [About & Links](./readme/about.md) — real-world apps, fun facts, useful links
- ⚪ [Contributing](./readme/contributing.md) — sponsorship, reporting issues, premium components
- ⚪ [Official Documentation](https://docs.duckframework.com) — full documentation

🟢 = start here &nbsp;·&nbsp; 🔵 = once you're building &nbsp;·&nbsp; ⚪ = optional reading

---

> **Duck is updated regularly** — check the repo for improvements and bug fixes.
