This release is a pre-release and may not be stable for production use.
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 function add <function_name> foo.py --server --context mycontext --description mydesc
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"
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
Linting
The flake8 config is at the root of this repo at .flake8.
When hacking on this library, please enable flake8 and add this line to your flake8 args (e.g., in your VSCode Workspace Settings):
--config=.flake8
Mypy Type Improvements
This script is handy for checking for any mypy types:
./check_mypy.sh
Please ignore [name-defined] errors for now. This is a known bug we are working to fix!
Strategies for QA'ing Changes To Generate Or Other Core Functionality
Our https://na1.polyapi.io has a large OOB catalog (as does eu1/na2). We also have several big internal PolyAPI projects with Python (message @eupharis if you need a pointer to which ones).
Running python -m polyapi generate in all these projects and then checking the flake8 and check_mypy steps above is a great way to build confidence that the generate changes has no gotchas.
Of course all this is in addition to the changes passing through normal unittests and integration tests!
Support
If you run into any issues or want help getting started with this project, please contact support@polyapi.io .
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file polyapi_python-0.3.20.dev0.tar.gz.
File metadata
- Download URL: polyapi_python-0.3.20.dev0.tar.gz
- Upload date:
- Size: 79.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59bb4b5d67bc83838ff6cbcd5e26028ae2496bf88e09ecadff1ba5cb61a111f1
|
|
| MD5 |
70c2ec3890822ea33c8b321ce50bf57e
|
|
| BLAKE2b-256 |
ca8f312000341bdd52cc57e159c8e55765beaf0b09fb679f5de2f6412d632f17
|
Provenance
The following attestation bundles were made for polyapi_python-0.3.20.dev0.tar.gz:
Publisher:
polyapi-update-python-package.yml on polyapi/polyapi-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
polyapi_python-0.3.20.dev0.tar.gz -
Subject digest:
59bb4b5d67bc83838ff6cbcd5e26028ae2496bf88e09ecadff1ba5cb61a111f1 - Sigstore transparency entry: 2192391725
- Sigstore integration time:
-
Permalink:
polyapi/polyapi-python@7ec610c7ea536739b60b62eea95fb24ea6ebe1f4 -
Branch / Tag:
refs/heads/develop - Owner: https://github.com/polyapi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
polyapi-update-python-package.yml@7ec610c7ea536739b60b62eea95fb24ea6ebe1f4 -
Trigger Event:
push
-
Statement type:
File details
Details for the file polyapi_python-0.3.20.dev0-py3-none-any.whl.
File metadata
- Download URL: polyapi_python-0.3.20.dev0-py3-none-any.whl
- Upload date:
- Size: 64.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91971450e9e631c57e0fc90e5444067d8622aeac86414b93582c604d9f55059d
|
|
| MD5 |
7fcd8e848d3ee112af0bd37122d0aa2e
|
|
| BLAKE2b-256 |
fd5e1432d1286ad0acd34b7586151dba2f469b74c6655bbe2dfa79506dbe3388
|
Provenance
The following attestation bundles were made for polyapi_python-0.3.20.dev0-py3-none-any.whl:
Publisher:
polyapi-update-python-package.yml on polyapi/polyapi-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
polyapi_python-0.3.20.dev0-py3-none-any.whl -
Subject digest:
91971450e9e631c57e0fc90e5444067d8622aeac86414b93582c604d9f55059d - Sigstore transparency entry: 2192391730
- Sigstore integration time:
-
Permalink:
polyapi/polyapi-python@7ec610c7ea536739b60b62eea95fb24ea6ebe1f4 -
Branch / Tag:
refs/heads/develop - Owner: https://github.com/polyapi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
polyapi-update-python-package.yml@7ec610c7ea536739b60b62eea95fb24ea6ebe1f4 -
Trigger Event:
push
-
Statement type:
