Skip to main content

Modern Gemini protocol server and client implementation using asyncio

Project description

Nauyaca - Gemini Protocol Server & Client

Python 3.14+ License: MIT Code style: Ruff Type checked: mypy Documentation

A modern, high-performance implementation of the Gemini protocol in Python. Nauyaca (pronounced "now-YAH-kah", meaning "serpent" in Nahuatl) uses asyncio's low-level Protocol/Transport pattern for efficient, non-blocking network I/O with both server and client capabilities.

Key Features

  • High Performance - asyncio Protocol/Transport pattern for maximum efficiency
  • Security First - Mandatory TLS 1.2+, TOFU certificate validation, rate limiting, and access control
  • Production Ready - TOML configuration, middleware system, and systemd integration
  • Developer Friendly - Full type hints, comprehensive tests, and modern tooling with uv

Read the full documentation

Quick Start

Installation

# As a CLI tool (recommended)
uv tool install nauyaca

# As a library
uv add nauyaca

# From source (for development)
git clone https://github.com/alanbato/nauyaca.git
cd nauyaca && uv sync

Run a Server

# Serve content from a directory
nauyaca serve ./capsule

# With configuration file
nauyaca serve --config config.toml

# With hot-reload for development
nauyaca serve ./capsule --reload

Fetch Content

# Get a Gemini resource
nauyaca get gemini://geminiprotocol.net/

# With verbose output
nauyaca get gemini://geminiprotocol.net/ --verbose

Use as a Library

import asyncio
from nauyaca.client import GeminiClient

async def main():
    async with GeminiClient() as client:
        response = await client.get("gemini://geminiprotocol.net/")

        if response.is_success():
            print(response.body)
        elif response.is_redirect():
            print(f"Redirect to: {response.redirect_url}")
        else:
            print(f"Error {response.status}: {response.meta}")

asyncio.run(main())

Documentation

nauyaca.readthedocs.io

Section Description
Installation Setup and requirements
Quick Start Get running in 5 minutes
Tutorials Step-by-step guides
How-to Guides Task-oriented recipes
Reference CLI, configuration, API
Explanation Architecture and concepts

Contributing

# Setup
git clone https://github.com/alanbato/nauyaca.git
cd nauyaca && uv sync

# Test
uv run pytest

# Lint & Type Check
uv run ruff check src/ tests/
uv run mypy src/

See CONTRIBUTING.md for guidelines.

License

MIT License - see LICENSE for details.

Resources

Acknowledgments

  • Solderpunk for creating the Gemini protocol
  • The Gemini community for feedback and inspiration

Status: Active development (pre-1.0). Core protocol and security features are stable.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nauyaca-0.5.1.tar.gz (51.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nauyaca-0.5.1-py3-none-any.whl (66.3 kB view details)

Uploaded Python 3

File details

Details for the file nauyaca-0.5.1.tar.gz.

File metadata

  • Download URL: nauyaca-0.5.1.tar.gz
  • Upload date:
  • Size: 51.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nauyaca-0.5.1.tar.gz
Algorithm Hash digest
SHA256 de238a03af223b4ce2c84a784b3c2aa187742258adce4c649be39d64596db5c8
MD5 443c86f2bacf41590f4bbe8d16b5161d
BLAKE2b-256 38904e40f6edc6bb0f001e66d67635e13e45df99f7ab1a369cc9e7d903d40073

See more details on using hashes here.

Provenance

The following attestation bundles were made for nauyaca-0.5.1.tar.gz:

Publisher: release-pypi.yml on alanbato/nauyaca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nauyaca-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: nauyaca-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 66.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nauyaca-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2acad3a306ea90ceadf2cd32a31e340cb311a7d2fa4c4f6d7b15759dd3dae63
MD5 f06e637e8fe50c1927de6777f06eb36d
BLAKE2b-256 b25f5fa6f99de3e6a1a84b7e4226f75fb091f2f2d5200d2a4dbf1cf74a138f70

See more details on using hashes here.

Provenance

The following attestation bundles were made for nauyaca-0.5.1-py3-none-any.whl:

Publisher: release-pypi.yml on alanbato/nauyaca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page