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.6.0.tar.gz (52.3 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.6.0-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nauyaca-0.6.0.tar.gz
Algorithm Hash digest
SHA256 284da39b8d49a1113a1bba0f1b2a84c0343618c92b7c648784f1511a2b316854
MD5 65e027aada23aa1c584b32af9af17f78
BLAKE2b-256 b8779c5047751a22b49dfa3c52f7bcbe5020828905732d6a7ea26baa26064f40

See more details on using hashes here.

Provenance

The following attestation bundles were made for nauyaca-0.6.0.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.6.0-py3-none-any.whl.

File metadata

  • Download URL: nauyaca-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 66.7 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4823c90f714bd1c9f27885f156578140e830db401d562ca3f27810f3b6e17a55
MD5 b8e58dd20306f48a9532a9107ca2b241
BLAKE2b-256 a17f7d92d5f5ea01636750c18f80c9687dbc564bccad39afcb81b69c75be9335

See more details on using hashes here.

Provenance

The following attestation bundles were made for nauyaca-0.6.0-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