Skip to main content

Expose your functions as HTTP endpoints.

Project description

dploy-kickstart

maintained PyPI version PyPI - Python Version workflow codecov

Expose your Python functions via an HTTP API. dploy-kickstart is designed with a focus of making deployment of machine learning models as easy as possible with as clean of a contract as possible. This means that you will find configurations options that are less relevant outside of this domain.

Installation

pip install dploy_kickstart

When installed it provides a kickstart executable. Have a look at the help functionality: kickstart --help.

Usage

dploy_kickstart is a helper utility that can expose your Python functions as HTTP endpoints. Based on comment annotations it wraps your chosen functions to be served as API endpoints. It is meant to be used via the kickstart CLI, hence, it would generally not be used programmatically.

Let's say you have a script.py with @dploy comment annotations:

# @dploy endpoint echo
def echo_func(payload):
    return payload

Serve this function with:

kickstart serve -e script.py

Let's try to call the endpoint via curl.

$ curl -d '{"foo":"bar"}' -H "Content-Type: application/json" -X POST http://localhost:8080/echo/

{"foo":"bar"}

Annotations

Following annotation options are currently available.

  • # @dploy endpoint {endpoint_path}
    Will expose the annotated function on path {endpoint_path} with trailing slash (and redirect without trailing slash).
  • # @dploy request_method {method}
    Specify allowed request method.
    default: post
    available: any method supported by Flask
  • # @dploy json_to_kwargs
    Will map json payload's keys to function kwargs if supplied.

Endpoint utilities

Following paths are generated automatically:

  • GET /healthz: that always returns a 200
  • GET /openapi.yaml: autogenerated OpenAPI Spec (WIP)

Current dependency tree

Aim is to keep this as small as possible to not clutter the user space.

$ poetry show --no-dev --tree

apispec 3.3.0 A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification).
click 7.1.2 Composable command line interface toolkit
flask 1.1.2 A simple framework for building complex web applications.
├── click >=5.1
├── itsdangerous >=0.24
├── jinja2 >=2.10.1
│   └── markupsafe >=0.23 
└── werkzeug >=0.15
paste 3.4.0 Tools for using a Web Server Gateway Interface stack
└── six >=1.4.0
waitress 1.4.3 Waitress WSGI server

Package naming

Isn't using underscores in package names discouraged? The reasoning behind the dploy_kickstart naming is that this utility is not meant to be used programmatically. Its meant to be used as a sidecar to user code that should be unaware of its existence, therefore, a longer name has a lower chance of clashing with user code. Yes, this is quite subjective.

Contributing

Questions, ideas, suggestions? Feel free to create issue or PR.

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

dploy-kickstart-0.1.9.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

dploy_kickstart-0.1.9-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file dploy-kickstart-0.1.9.tar.gz.

File metadata

  • Download URL: dploy-kickstart-0.1.9.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1031-azure

File hashes

Hashes for dploy-kickstart-0.1.9.tar.gz
Algorithm Hash digest
SHA256 da9ad242d34913110fa8e9f6fa78391c0cbdde6c35632a9acd2f41b204620b02
MD5 9d3be4a405f7d6439e3779523173d3f6
BLAKE2b-256 4987c4ef6cac68cbae213eadeaf5cf2bd4a3de270da94b271f6fbe6f01063b3c

See more details on using hashes here.

File details

Details for the file dploy_kickstart-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: dploy_kickstart-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1031-azure

File hashes

Hashes for dploy_kickstart-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4f074528b6b09874c1eea81a5a1129c781b1570532d6854a5768901c55b2f194
MD5 50dbef529d8102361b734a5aded07e22
BLAKE2b-256 a79b06fee4bc7b7416ef1cffe1980cfea5463b20a4d6475930b4f3d1c5555d62

See more details on using hashes here.

Supported by

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