Skip to main content

A simple FastAPI webserver with a bunch of useful resources.

Project description

FastAPI WebServer

This is a wrapper of a FAST API application with some additional features that might be useful for quick web development.

It features:

  • Powerful environment and settings handling with Dynamic module import like Django;
  • Powerful database tools:
    • A Database Adapter to connect to any database on-the-fly;
    • A Data Migration Tool, to run .sql files, or migrate json data that runs automagically on server startup;
    • A FastAPI Dependency for the database (webserver.core.ServerDatabase)
    • A SQLite Cache Database + FastAPI dependency (webserver.core.ServerCache)
  • An SMTP service, implemented on top of fastapi-mail;
  • Internationalization (i18n) on top of Babel:
    • A FastAPI Dependency that discovers the locale based on HTTP Header Accept-Language (webserver.core.AvailableLocale)
  • Front-end tools:
    • CSS/SASS Compiler (webserver.frontend.css);
    • Server-Side Rendering via Jinja2Template;
  • Static Files provider;
  • CORS Support;
  • TLS Support + mkcert certificates (local/development only)
  • Content Proxies (webserver.extras.proxies):
    • Gravatar
    • GIPHY

Roadmap

The following features are expected to be implemented in the future. Contribution is welcome.

  • OCI-Compliant Image for Docker/Podman
  • Local Key-Value Cache
  • Logging and Tracing API (via OpenTelemetry)
  • Authentication and Authorization
  • Traffic Analyzer
    • (AI) Bot detector
    • VPN detector
    • Rate limiter
    • IP-based Access-Control List (ACL)
  • Content Providers (HTTP client and proxy)
    • Google Fonts API

Getting Started

Optionally, set up the environment variables. All environment variables can be found on .env file in the root of this repository.

import webserver
from fastapi import APIRouter, FastAPI

router: APIRouter = APIRouter()
app: FastAPI = webserver.app


@router.get("/")
def index():
  return {"Hello World": f"from {webserver.settings.APP_NAME}"}


app.include_router(router)

if __name__ == "__main__":
  webserver.start()

This enables both local execution through main method as well as fastapi (dev|run) commands.

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

fastapi_webserver-0.4.8.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

fastapi_webserver-0.4.8-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_webserver-0.4.8.tar.gz.

File metadata

  • Download URL: fastapi_webserver-0.4.8.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for fastapi_webserver-0.4.8.tar.gz
Algorithm Hash digest
SHA256 89a0f9bc5012074fcac254836900c0acaf54d78639646ad30958cfe3aeded2e8
MD5 7feca92bf874adc6bcbc7c5517498906
BLAKE2b-256 f427ad23812fea4dea344beed4eccb7204e476fcd125112f575e1dcbb2549c42

See more details on using hashes here.

File details

Details for the file fastapi_webserver-0.4.8-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_webserver-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 52ec003222ca07484be5939e855b33fac50bc94117cc8188ad9ea81e44f5a8e8
MD5 5b0e23b2042d7a1e84c52c65dff53c0a
BLAKE2b-256 efbd8138ecb2bd466638ff1a786bab1be530bfd6360f4549173024e6fee80fdd

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