Skip to main content
Jararaca Logo

Jararaca Microservice Framework

Overview

Jararaca is an async-first microservice framework designed to simplify the development of distributed systems. It provides a comprehensive set of tools for building robust, scalable, and maintainable microservices with a focus on developer experience and type safety.

Key Features

REST API Development

  • Easy-to-use interfaces for building REST APIs
  • Automatic request/response validation
  • Type-safe endpoints with FastAPI integration
  • Automatic OpenAPI documentation generation

Message Bus Integration

  • Topic-based message bus for event-driven architecture
  • Support for both worker and publisher patterns
  • Built-in message serialization and deserialization
  • Easy integration with AIO Pika for RabbitMQ

Distributed WebSocket

  • Room-based WebSocket communication
  • Distributed broadcasting across multiple backend instances
  • Automatic message synchronization between instances
  • Built-in connection management and room handling

Task Scheduling

  • Cron-based task scheduling
  • Support for overlapping and non-overlapping tasks
  • Distributed task execution
  • Easy integration with message bus for task distribution

TypeScript Integration

  • Automatic TypeScript interface generation
  • Command-line tool for generating TypeScript types
  • Support for REST endpoints, WebSocket events, and message bus payloads
  • Type-safe frontend-backend communication
  • @ExposeType decorator - Explicitly expose types for TypeScript generation without needing them in endpoints

Hexagonal Architecture

  • Clear separation of concerns
  • Business logic isolation from infrastructure
  • Easy testing and maintainability
  • Dependency injection for flexible component management

Observability

  • Built-in OpenTelemetry integration
  • Distributed tracing support
  • Logging and metrics collection
  • Performance monitoring capabilities

Quick Start

Installation

pip install jararaca

Basic Usage

from jararaca import Microservice, create_http_server
from jararaca.presentation.http_microservice import HttpMicroservice

# Define your microservice
app = Microservice(
    providers=[
        # Add your providers here
    ],
    controllers=[
        # Add your controllers here
    ],
    interceptors=[
        # Add your interceptors here
    ],
)

# Create HTTP server
http_app = HttpMicroservice(app)
web_app = create_http_server(app)

Running the Service

# Run as HTTP server
jararaca server app:http_app

# Run as message bus worker
jararaca worker app:app

# Run as scheduler
jararaca scheduler app:app

# Generate TypeScript interfaces
jararaca gen-tsi app.main:app app.ts

Documentation

For detailed documentation, please visit our documentation site.

Examples

Check out the examples directory for complete working examples of:

  • REST API implementation
  • WebSocket usage
  • Message bus integration
  • Task scheduling
  • TypeScript interface generation

Contributing

Contributions are welcome! Please read our contributing guidelines for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for jararaca 0.5.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jararaca 0.5.18
File Size Uploaded Provenance Actions
jararaca-0.5.18.tar.gz 504.3 kB Without provenance Details for jararaca-0.5.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jararaca 0.5.18
File Interpreter ABI Platform Actions
jararaca-0.5.18-py3-none-any.whl Python 3 none any Details for jararaca-0.5.18-py3-none-any.whl

Total release size: 725.8 kB

Release files / jararaca-0.5.18.tar.gz

Download URL jararaca-0.5.18.tar.gz
Size 504.3 kB
Tags Source
SHA-256 checksum
How to use checksums
9368c3e55af63236e42adae7a7213588a348673e1fd37575acacad59b9447ce2
BLAKE2b-256 checksum
How to use checksums
cc56586ea313e6fe02d3faecb08807b908f40f653a165ea4c9e639f267a62869
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.14.7 Linux/7.2.15-ogc1.1.fc45.x86_64

Release files / jararaca-0.5.18-py3-none-any.whl

Download URL jararaca-0.5.18-py3-none-any.whl
Size 221.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a631e8ed8f731ddfb822b27e5a4fbe7351c1f2e43ede741f0858a1755ee837fd
BLAKE2b-256 checksum
How to use checksums
33c2b5a8a5b3f4acc162352484c4589077b4eb359fdd32eedd948c2c3ed2ab96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.14.7 Linux/7.2.15-ogc1.1.fc45.x86_64

Security for jararaca 0.5.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.18 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page