Skip to main content

Docker images and utilities to power your Python APIs and help you ship faster.

Project description

🚢 inboard 🐳

inboard logo

Docker images and utilities to power your Python APIs and help you ship faster.

PyPI GitHub Container Registry coverage ci Ruff

Mentioned in Awesome FastAPI

Description

This repository provides Docker images and a PyPI package with useful utilities for Python web servers. It runs Uvicorn with Gunicorn, and can be used to build applications with Starlette and FastAPI.

Justification

Why use this project? You might want to try out inboard because it:

  • Offers a Python package and Docker images that work together. Python packages and Docker images don't automatically share the same versioning systems, but inboard can help with this. You might install the Python package with a minor version constraint. You can also pull the corresponding Docker image by specifying the minor version in the Docker tag (FROM ghcr.io/br3ndonland/inboard:<version>).
  • Tests everything. inboard performs unit testing of 100% of the Python code, and also runs smoke tests of the Docker images each time they are built.
  • Sets sane defaults, but allows configuration. Configure a variety of settings with environment variables. Or run it as-is and it just works.
  • Configures logging extensibly. inboard simplifies logging by handling all its Python log streams with a single logging config. It also offers the ability to filter health check endpoints out of the access logs. Don't like it? No problem. You can easily extend or override the logging behavior.

Quickstart

Get started with Docker, pull and run an image, and try an API endpoint.

docker pull ghcr.io/br3ndonland/inboard
docker run -d -p 80:80 --platform linux/amd64 ghcr.io/br3ndonland/inboard
http :80  # HTTPie: https://httpie.io/

Documentation

Documentation is built with Material for MkDocs, deployed on Vercel, and available at inboard.bws.bio and inboard.vercel.app.

Vercel build configuration:

  • Build command: python3 -m pip install mkdocs-material && mkdocs build --site-dir public
  • Output directory: public (default)

Vercel site configuration is specified in vercel.json.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

inboard-0.72.3.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

inboard-0.72.3-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file inboard-0.72.3.tar.gz.

File metadata

  • Download URL: inboard-0.72.3.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inboard-0.72.3.tar.gz
Algorithm Hash digest
SHA256 25e729cbcd027e523012a073a9d08d0c5097b5f97a78d5f7915defcc31bc9f13
MD5 2e08da743ddfe9d456742347ddb85d4a
BLAKE2b-256 c75d1fbed242b7729b52822a556f145296ef129270ab90abf6cfd9d0b12fb065

See more details on using hashes here.

Provenance

The following attestation bundles were made for inboard-0.72.3.tar.gz:

Publisher: ci.yml on br3ndonland/inboard

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

File details

Details for the file inboard-0.72.3-py3-none-any.whl.

File metadata

  • Download URL: inboard-0.72.3-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inboard-0.72.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d14d4df82597765b78a4789be832fd83fd29bfa6ab9e7426241209bb045d3996
MD5 d8084902faf559d619af54b9eb8ab1dc
BLAKE2b-256 eb5ea4723094c3da16f9fc0e6eb4575fb9bda781c5377c9a4956bdb84ce1b10d

See more details on using hashes here.

Provenance

The following attestation bundles were made for inboard-0.72.3-py3-none-any.whl:

Publisher: ci.yml on br3ndonland/inboard

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

Supported by

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