Skip to main content

The Python Client for PolyAPI, the IPaaS by Developers for Developers

Project description

PolyAPI Python Library

The PolyAPI Python Library lets you use and define PolyAPI functions using Python.

PolyAPI Quickstart

1. Install Libraries

First install the client.

We recommend the use of venv so you can have multiple projects each with separate credentials:

python -m venv myvenv
source myvenv/bin/activate
pip install polyapi-python

Replace myvenv with whatever you'd like your venv to be named!

For more on Python virtual environments, we recommend this venv primer.

However, if you only need to use polyapi with a single project, you can do a basic install:

pip install polyapi-python

2. Generate Your Functions

Now you can run the following to generate your library

python -m polyapi generate

You will be prompted to enter the Poly server url you use and your Poly API key.

You can also provide the key and url as environment variables (useful for deployment):

POLY_API_KEY='your_key'
POLY_API_BASE_URL='your_server'  # e.g. na1.polyapi.io

3. Test

That's it! Now open up a test file and you can run some code like so:

from polyapi import poly
print(poly.polyapi.function.api.list(my_server, my_api_key))

Add New Server Functions

To add a new server function, please follow the quickstart. Then you can add a server function like so:

python -m polyapi --context mycontext --description mydesc --server function add <function_name> foo.py

The code in foo.py should contain a single defined function named the same as your <function_name> variable.

So for example, if you want to add a function named bar, your file foo.py would look like this:

def bar():
    return "Hello World"

See Server Function Logs

In order to see function logs, please first set logsEnabled to true in Canopy for the function.

https://na1.polyapi.io/canopy/polyui/collections/server-functions

Then in your code, get the poly logger and log with it like so:

logger = logging.getLogger("poly")
def bar():
    logger.warning("I AM THE LOG")
    return "Hello World"

Finally, click the "Show Logs" button to see your server function logs in Canopy!

Complex Types In Server Functions

You can define arbitrarily complex argument and return types using TypedDicts.

NOTE: you must use TypedDict from typing_extensions, not from the base typing module.

from typing_extensions import TypedDict


class Foobar(TypedDict):
    count: int


def bar(n: int) -> Foobar:
    return Foobar(count=n)

Pypi

This library is hosted on Pypi. You can find the latest version on the pypi polyapi-python project.

Upgrade

To upgrade your library to the latest version, pass the upgrade flag.

pip install polyapi-python --upgrade

Pre-Release

To upgrade your library to the latest dev version, pass the --pre flag.

pip install polyapi-python --pre --upgrade

Change Your API Key

If you need to change your API key or what server you are pointing to, you can run:

python -m polyapi setup

Unit Tests

To run this library's unit tests, please clone the repo then run:

python -m unittest discover

Support

If you run into any issues or want help getting started with this project, please contact support@polyapi.io

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

polyapi_python-0.3.1.dev14.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

polyapi_python-0.3.1.dev14-py3-none-any.whl (40.9 kB view details)

Uploaded Python 3

File details

Details for the file polyapi_python-0.3.1.dev14.tar.gz.

File metadata

  • Download URL: polyapi_python-0.3.1.dev14.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for polyapi_python-0.3.1.dev14.tar.gz
Algorithm Hash digest
SHA256 a2290dc07de8e1c677b2302c24bbcbea08ace51ffa9bff0569688ea411b6df79
MD5 66db37003925572c7f3810003144b0f9
BLAKE2b-256 6092c8fa8cbb9057b2784c2a249f5668866d50747d45e5739dacf9584bd6e3f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for polyapi_python-0.3.1.dev14.tar.gz:

Publisher: polyapi-update-python-package.yml on polyapi/polyapi-python

Attestations:

File details

Details for the file polyapi_python-0.3.1.dev14-py3-none-any.whl.

File metadata

File hashes

Hashes for polyapi_python-0.3.1.dev14-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab8f2888f9251e12e7c9432ce81ae978fdb00eadd72480c073bef99f13f297d
MD5 d815c3ea871256fa00243191c5d4d272
BLAKE2b-256 c041be7ac8fe4adf49cd55b0f78d8ee5a0f85412f7c1bc4c11a09605e2b9f29d

See more details on using hashes here.

Provenance

The following attestation bundles were made for polyapi_python-0.3.1.dev14-py3-none-any.whl:

Publisher: polyapi-update-python-package.yml on polyapi/polyapi-python

Attestations:

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