Skip to content
⚡ Zenith

Examples Overview

Learning Through Examples

Section titled “Learning Through Examples”

Reading API documentation alone rarely provides the complete picture. You need to see how concepts work together in practice, understand common patterns, and learn from real implementations.

Learning Paths

Section titled “Learning Paths”

Quick Start Path

Section titled “Quick Start Path”

If you want to get productive fast:

Building APIs Path

Section titled “Building APIs Path”

Learn to build production-ready APIs:

💬 Real-time Features Path

Section titled “💬 Real-time Features Path”

Build interactive applications:

Full-Stack Path

Section titled “Full-Stack Path”

Build complete applications:

Auto-Generated Examples

Section titled “Auto-Generated Examples”

We automatically generate documentation from our example files to ensure they’re always up-to-date:

Browse All Auto-Generated Examples →

Highlights from Auto-Generated Collection:

Section titled “Highlights from Auto-Generated Collection:”

Example Categories

Section titled “Example Categories”

By Complexity

Section titled “By Complexity”

Beginner (5 minutes)

Section titled “Beginner (5 minutes)”

Intermediate (15 minutes)

Section titled “Intermediate (15 minutes)”

Advanced (30+ minutes)

Section titled “Advanced (30+ minutes)”

By Feature

Section titled “By Feature”

Core Features

Section titled “Core Features”

Middleware

Section titled “Middleware”

Real-time

Section titled “Real-time”

Background Processing

Section titled “Background Processing”

Running Examples

Section titled “Running Examples”

Quick Run

Section titled “Quick Run”
Terminal window
# Clone the repository
git clone https://github.com/nijaru/zenith
cd zenith


# Install Zenith
pip install -e .


# Run any example
python examples/00-hello-world.py

With Virtual Environment

Section titled “With Virtual Environment”
Terminal window
# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate


# Install dependencies
pip install zenithweb


# Run example
python examples/03-modern-developer-experience.py

Common Patterns

Section titled “Common Patterns”

API Structure

Section titled “API Structure”

Most examples follow this pattern:

from zenith import Zenith


app = Zenith()  # Zero-config setup


@app.get("/")
async def root():
    return {"message": "Hello World"}


if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

Testing Examples

Section titled “Testing Examples”

Many examples include test code:

Terminal window
# Run the example
python examples/16-testing-patterns.py


# In another terminal, test the API
curl http://localhost:8000/

Contributing Examples

Section titled “Contributing Examples”

We welcome new examples! When creating examples:

  1. Keep it focused - One concept per example
  2. Add comments - Explain non-obvious code
  3. Include a docstring - Describe what the example demonstrates
  4. Test it works - Ensure the example runs without errors
  5. Follow conventions - Use consistent style with other examples

Next Steps

Section titled “Next Steps”

After exploring examples:

Need Help?

Section titled “Need Help?”

Examples are the fastest way to learn Zenith. Start with Hello World and build your way up!