# 🚢 inboard 🐳
<img src="https://raw.githubusercontent.com/br3ndonland/inboard/develop/docs/assets/images/inboard-logo.svg" alt="inboard logo" width="90%" />
_Docker images and utilities to power your Python APIs and help you ship faster._
[](https://pypi.org/project/inboard/)
[](https://github.com/br3ndonland/inboard/pkgs/container/inboard)
[](https://pycqa.github.io/isort/)
[](https://black.readthedocs.io/en/stable/)
[](https://coverage.readthedocs.io/en/latest/)
[](https://github.com/br3ndonland/inboard/actions)
[](https://github.com/mjhea0/awesome-fastapi)
## Description
This repository provides [Docker images](https://github.com/br3ndonland/inboard/pkgs/container/inboard) and a [PyPI package](https://pypi.org/project/inboard/) with useful utilities for Python web servers. It runs [Uvicorn with Gunicorn](https://www.uvicorn.org/), and can be used to build applications with [Starlette](https://www.starlette.io/) and [FastAPI](https://fastapi.tiangolo.com/).
## Quickstart
[Get started with Docker](https://www.docker.com/get-started), pull and run an image, and try an API endpoint.
```sh
docker pull ghcr.io/br3ndonland/inboard
docker run -d -p 80:80 ghcr.io/br3ndonland/inboard
http :80 # HTTPie: https://httpie.io/
```
## Documentation
Documentation is built with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), deployed on [Vercel](https://vercel.com/), and available at [inboard.bws.bio](https://inboard.bws.bio) and [inboard.vercel.app](https://inboard.vercel.app).
[Vercel build configuration](https://vercel.com/docs/build-step):
- Build command: `python3 -m pip install 'mkdocs-material>=8,<9' && mkdocs build --site-dir public`
- Output directory: `public` (default)
[Vercel site configuration](https://vercel.com/docs/configuration) is specified in _vercel.json_.
Raw data
{
"_id": null,
"home_page": "https://github.com/br3ndonland/inboard",
"name": "inboard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "asgi,docker,fastapi,gunicorn,uvicorn",
"author": "Brendon Smith",
"author_email": "bws@bws.bio",
"download_url": "https://files.pythonhosted.org/packages/c2/cb/4bd0e221fc2225598d8f2bcc6aa1d566e2d4006a68554cf17bd4e728ed1f/inboard-0.26.0.tar.gz",
"platform": null,
"description": "# \ud83d\udea2 inboard \ud83d\udc33\n\n<img src=\"https://raw.githubusercontent.com/br3ndonland/inboard/develop/docs/assets/images/inboard-logo.svg\" alt=\"inboard logo\" width=\"90%\" />\n\n_Docker images and utilities to power your Python APIs and help you ship faster._\n\n[](https://pypi.org/project/inboard/)\n[](https://github.com/br3ndonland/inboard/pkgs/container/inboard)\n[](https://pycqa.github.io/isort/)\n[](https://black.readthedocs.io/en/stable/)\n[](https://coverage.readthedocs.io/en/latest/)\n[](https://github.com/br3ndonland/inboard/actions)\n\n[](https://github.com/mjhea0/awesome-fastapi)\n\n## Description\n\nThis repository provides [Docker images](https://github.com/br3ndonland/inboard/pkgs/container/inboard) and a [PyPI package](https://pypi.org/project/inboard/) with useful utilities for Python web servers. It runs [Uvicorn with Gunicorn](https://www.uvicorn.org/), and can be used to build applications with [Starlette](https://www.starlette.io/) and [FastAPI](https://fastapi.tiangolo.com/).\n\n## Quickstart\n\n[Get started with Docker](https://www.docker.com/get-started), pull and run an image, and try an API endpoint.\n\n```sh\ndocker pull ghcr.io/br3ndonland/inboard\ndocker run -d -p 80:80 ghcr.io/br3ndonland/inboard\nhttp :80 # HTTPie: https://httpie.io/\n```\n\n## Documentation\n\nDocumentation is built with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), deployed on [Vercel](https://vercel.com/), and available at [inboard.bws.bio](https://inboard.bws.bio) and [inboard.vercel.app](https://inboard.vercel.app).\n\n[Vercel build configuration](https://vercel.com/docs/build-step):\n\n- Build command: `python3 -m pip install 'mkdocs-material>=8,<9' && mkdocs build --site-dir public`\n- Output directory: `public` (default)\n\n[Vercel site configuration](https://vercel.com/docs/configuration) is specified in _vercel.json_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Docker images and utilities to power your Python APIs and help you ship faster.",
"version": "0.26.0",
"split_keywords": [
"asgi",
"docker",
"fastapi",
"gunicorn",
"uvicorn"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6311e1f620097f037be4295d7a9155f3",
"sha256": "26e31d06ca8f24ac88f07a418c8a24dc875caf0179cbb26de31bbde17c019b6c"
},
"downloads": -1,
"filename": "inboard-0.26.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6311e1f620097f037be4295d7a9155f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 12742,
"upload_time": "2022-05-14T21:07:30",
"upload_time_iso_8601": "2022-05-14T21:07:30.270706Z",
"url": "https://files.pythonhosted.org/packages/60/0e/c0c4f0342f15cbbd2301fc2d06ec0d63263028c802148795d0862bbfcd27/inboard-0.26.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "821d844f81626965076a1eedf0172eb5",
"sha256": "320a924e769307f3f246e72e985b38704f6d97b7c44b21ba36c775d8072e864b"
},
"downloads": -1,
"filename": "inboard-0.26.0.tar.gz",
"has_sig": false,
"md5_digest": "821d844f81626965076a1eedf0172eb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 10941,
"upload_time": "2022-05-14T21:07:32",
"upload_time_iso_8601": "2022-05-14T21:07:32.139663Z",
"url": "https://files.pythonhosted.org/packages/c2/cb/4bd0e221fc2225598d8f2bcc6aa1d566e2d4006a68554cf17bd4e728ed1f/inboard-0.26.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-14 21:07:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "br3ndonland",
"github_project": "inboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "inboard"
}