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

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.4.1.tar.gz (46.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.4.1-py3-none-any.whl (59.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nauyaca-0.4.1.tar.gz
  • Upload date:
  • Size: 46.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.4.1.tar.gz
Algorithm Hash digest
SHA256 2a84224a7adb4f0676b0158655ff15e3a7ace603f78d82d7bed87341f7df0ec7
MD5 980caca1d4e14ed6d4fd7dc67b9cdd93
BLAKE2b-256 f27068fffc25b2682b826e4a07fbbb8dfd7ded13cc12b1fce2abedd6d00997fe

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: nauyaca-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 59.1 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f5d93f2699725752d6b19144857341d4cccefb39b52e2af321764677af259f6a
MD5 31d275e848fe25b48cd71925a11daa38
BLAKE2b-256 53c53a2beaf719bee1404f7db3210719a9d3adc0f779eff1038ea895d0221d01

See more details on using hashes here.

Provenance

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