Skip to main content

A service management framework

Project description

Nautica V3

Nautica V3 (also referred to as Nautica API, Nautica3, N3) is a modular application framework built around a service registry. It provides you with a structured way to manage components of your applications, such as HTTP or Socket servers, background workers, etc.

What's Included

  • Service Registry with dependency resolver
  • Lifecycle hooks for install, start and shutdown
  • TOML Config system with key management
  • Logger with file output and memory
  • Shell for interacting with services
  • TUI for live logs, thread and worker inspection (optional)
  • Plugin system for extending projects without modifying core code
  • Many Built-in Services, including HTTP API

I made N3 because I was solving the same problems in my projects, those being: configs, logging, figuring out startup orders, not to mention the validation boilerplate on every route. Because of this I made Nautica V2, which solved many of these issues, and V3 to improve on the idea.

Get Started

Firstly, install Nautica:

pip install nautica

To create a project, use the CLI (docs):

nautica create my-project
cd my-project
nautica run .

To setup an existing project:

cd my-project
nautica install
nautica run .

How HTTP API Compares

Benchmark Performance

Library Requests/Second Avg Latency Overall
Nautica3 2271 4.4ms -
FastAPI 2259 4.4ms 0.5% slower
Flask 75 132.6ms 96% slower

Ran with 10 workers, for 10 seconds. Nautica3 matches FastAPI despite running additional middleware, requirement parsing, and logging on every request.

Code Complexity

Similarly to SvelteKit, Nautica defines the route names for you. This helps to reduce boilerplate (see Flask and FastAPI examples), improve readability, and helps with naming conventions

Nautica3

# file: src/http/api/v1/auth.py
from napi.http import HTTP, Context, Reply
from somewhere import username, password

@HTTP.POST()
@HTTP.Require(body = {"username": str, "password": str})
def login(ctx: Context):
    if ctx.body["username"] == username and ctx.body["password"] == password:
        return Reply(ok=True)
    return Reply(ok=False, error="Invalid credentials"), 401

Flask

# file: main.py
from flask import Flask, request
from flask.blueprints import Blueprint
import json
from somewhere import username, password

app = Flask(__name__)
v1auth = Blueprint("v1auth", __name__, url_prefix="/api/v1/auth")

@v1auth.post("/login")
def login():
    data = request.get_json(silent=True) or {}
    if data.get("username") == username and data.get("password") == password:
        return json.dumps({"ok": True})
    return json.dumps({"ok": False, "error": "Invalid credentials"}), 401

app.register_blueprint(v1auth)
app.run(port=8101)

FastAPI

# file: main.py
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
import uvicorn
from somewhere import username, password

app = FastAPI()

class LoginRequest(BaseModel):
    username: str
    password: str

@app.post("/api/v1/auth/login")
def login(body: LoginRequest):
    if body.username == username and body.password == password:
        return {"ok": True}
    raise HTTPException(status_code=401, detail="Invalid credentials")

uvicorn.run(app, port=8101)

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

nautica-3.0.1.tar.gz (38.4 kB view details)

Uploaded Source

Built Distribution

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

nautica-3.0.1-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file nautica-3.0.1.tar.gz.

File metadata

  • Download URL: nautica-3.0.1.tar.gz
  • Upload date:
  • Size: 38.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for nautica-3.0.1.tar.gz
Algorithm Hash digest
SHA256 08811e3e1ba7148854e74f8136d8f55fafd3eb43e5e44d1103d7580453cfddd8
MD5 51d7b4fdf6aab16c39a4d71d7009d673
BLAKE2b-256 c191cafe09fb1d590389982963c5e9fadb0bb799017239ddbe5e674c10d60dc5

See more details on using hashes here.

File details

Details for the file nautica-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: nautica-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for nautica-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 02b62bdf40997602016c3e386afe2647819efb1e1ea448b90bdbd6ae4d4d86b3
MD5 8824c10c2d7a461b7ce16cd4f45800ba
BLAKE2b-256 8b7f09717c1b2d8c63c73bef3ba884ebc0b7f06105255cff18d0b73c12118709

See more details on using hashes here.

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