Evolve App Server Python Client
This library provides a wrapper to the Evolve App Server's API, allowing users of the Evolve SDK to authenticate with the Evolve App Server and upload studies.
Usage
from geojson import FeatureCollection
from src.zepben.eas import EasClient, StudyInput, StudyResultInput, GeoJsonOverlayInput, ResultSectionInput,
SectionType, Mutation
eas_client = EasClient(
host="<host>",
port=1234,
access_token="<access_token>",
asynchronous=False,
)
eas_client.mutation(
Mutation.add_studies(
[
StudyInput(
name="<study name>",
description="<study description>",
tags=["<tag>", "<tag2>"],
results=[
StudyResultInput(
name="<result_name>",
geoJsonOverlay=GeoJsonOverlayInput(
data=FeatureCollection(...),
styles=["style1"]
),
sections=[
ResultSectionInput(
type=SectionType.TABLE,
name="<table name>",
description="<table description>",
columns=[
{"key": "<column 1 key>", "name": "<column 1 name>"},
{"key": "<column 2 key>", "name": "<column 2 name>"},
],
data=[
{"<column 1 key>": "<column 1 row 1 value>",
"<column 2 key>": "<column 2 row 1 value>"},
{"<column 1 key>": "<column 1 row 2 value>",
"<column 2 key>": "<column 2 row 2 value>"}
]
)
]
)
],
styles=[
{
"id": "style1",
# other Mapbox GL JS style properties
}
]
)
]
)
)
eas_client.close()
AsyncIO
The EasClient can operate in async mode if specified, like so:
from aiohttp import ClientSession
from geojson import FeatureCollection
from src.zepben.eas import EasClient, StudyInput, StudyResultInput, GeoJsonOverlayInput, ResultSectionInput,
SectionType, Mutation
async def upload():
eas_client = EasClient(
host="<host>",
port=1234,
access_token="<access_token>",
asynchronous=True, # returns all methods as plain async methods
)
await eas_client.mutation(
Mutation.add_studies(
[
StudyInput(
name="<study name>",
description="<study description>",
tags=["<tag>", "<tag2>"],
results=[
StudyResultInput(
name="<result_name>",
geoJsonOverlay=GeoJsonOverlayInput(
data=FeatureCollection(...),
styles=["style1"]
),
sections=[
ResultSectionInput(
type=SectionType.TABLE,
name="<table name>",
description="<table description>",
columns=[
{"key": "<column 1 key>", "name": "<column 1 name>"},
{"key": "<column 2 key>", "name": "<column 2 name>"},
],
data=[
{"<column 1 key>": "<column 1 row 1 value>",
"<column 2 key>": "<column 2 row 1 value>"},
{"<column 1 key>": "<column 1 row 2 value>",
"<column 2 key>": "<column 2 row 2 value>"}
]
)
]
)
],
styles=[
{
"id": "style1",
# other Mapbox GL JS style properties
}
]
)
]
)
)
await eas_client.close()
I'm used to the old client, what do i do?
Migrating existing code
Most of the objects passed into requests are similar. The new EasClient is fully type hinted and self documenting.
For example.
from src.zepben.eas import EasClient, WorkPackageInput, HcExecutorConfigInput, FeederConfigsInput, FeederConfigInput
client = EasClient(host='host', port=1234)
client.get_work_package_cost_estimation(
WorkPackageInput(
feederConfigs=FeederConfigsInput(
configs=[
FeederConfigInput(
feeder='myFeeder',
years=[2024, 2025],
scenarios=['scenario1']
)
]
)
)
)
Hovering over any kwarg or looking at any class definition will show all possible parameters, and their expected types.
Enabling legacy convenience methods
Legacy convenience methods can be enabled by passing enable_legacy_methods to __init__ of EasClient. eg:
from src.zepben.eas import EasClient
client = EasClient(enable_legacy_methods=True)
This will enable all deprecated and opt_in methods on the class, they are disabled by default.
Development
To regenerate the graphql client, run the following command
docker compose run codegen
If you have done any of the following, you will need to regenerate the docker image if testing locally.
- Made changes to anything that affects the python package
- Changed anything under
ariadne_plugins
docker build .
1 maintainer
Release files for zepben.eas 2.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zepben_eas-2.18.0.tar.gz | 61.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zepben_eas-2.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 117.9 kB
Release files / zepben_eas-2.18.0.tar.gz
| Download URL | zepben_eas-2.18.0.tar.gz |
|---|---|
| Size | 61.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f04eda24a9ed17696eb9b3356c33faf6d14afc2c97c9268eb835eca34ee0520
|
|
BLAKE2b-256 checksum How to use checksums |
db798344d84e62222757431291815327f4051df6ddbe7da09fa11c2f84641691
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / zepben_eas-2.18.0-py3-none-any.whl
| Download URL | zepben_eas-2.18.0-py3-none-any.whl |
|---|---|
| Size | 56.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd336e4f73924b1b6d749fe49de3c6ea0b4e1540c6e835c639e9d2e2601bee2d
|
|
BLAKE2b-256 checksum How to use checksums |
311b1811dc40f59d3af9d10341d93d4c9f70bc7693242f4007aaf9581675e250
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
