Package: threedi-api-client
threedi-api-clientA Python library for interfacing with the 3Di APIFree software: BSD licenseDocumentation:https://threedi-api-client.readthedocs.ioFeaturesObject-oriented API interaction generated withhttps://openapi-generator.tech/.Asynchronous support.Advanced file download and upload utility functions.InstallationWe recommendpipto install this package:pip install --user threedi-api-clientIf async support is required, install as follows:pip install --user threedi-api-client[aio]CreditsThe OpenAPI client has been generated with OpenAPI generator (https://openapi-generator.tech/), which is
licensed under the Apache License 2.0.This package was created withCookiecutterand theaudreyr/cookiecutter-pypackageproject template.History4.1.5 (2023-11-21)Update to framework release 3.2.754.1.4 (2023-06-19)Allow passing (extra) HTTP headers viafile_uploadfunction.4.1.3 (2023-06-14)Release 3.2.34Build the release with the build package instead of setuptools.Rewrite release workflow to use a supported github action for github release.4.1.2 (2023-04-25)Public release.4.1.2b (2023-03-13)Updated to framework release 3.2.6Fix timeout when retrying uploads.4.1.1 (2022-11-21)Also improve support for HTTP proxies for async upload/download functionality.4.1.0 (2022-11-21)Support S3 (object storage) temp-urls in upload/download functions in aio/files.py by
disabling the automatic addition of the ‘content-type’ header by aiohttp.Increase default socket read timeout for (async) downloads to 60 seconds.Increase default socket connect timeout for uploads to 30 seconds.Make the sync and async ApiException the same.Improved support for HTTP proxies with async API client.Support the November 2022 API (3.0) release.4.0.1 (2022-06-08)Support personal api tokens authentication.Added OAuth2 token and OAuth2 token refresh capability (for both public
and private clients).Make server-side MD5 check optional to account for the fact that S3 presigned
urls cannot be used with custom headers (like Content-MD5) unless they are included
in the signing procedure.Allow usage of the API client without supplying a refresh token.Added automatic refresh for OAuth2 tokens obtained through the client credentials grant.4.0.0 (2022-02-11)First stable release with newThreediApiclient includedShow warning when data fetched from API cannot be succesfully valided by the client-side validation.4.0.0b4 (2022-01-26)Renamedsimulation_templatestosimulation-templates4.0.0b3 (2022-01-26)Added Threedimodelis_validfield as alias forinp_successAdded Simulationthreedicore_versionfield andcloned_fromfieldAddedstatusendpoints andversionendpoints4.0.0b2 (2022-01-17)Fix distribution.4.0.0b1 (2022-01-17)Added support forperiodic(dailyonly for now) lateral fileSupport for 1D initial waterlevels from file.Show warnings in cases of unknown enum values instead of raising errors.Added callback support for async/sync download/upload functionsAdded structure controls file uploadAdded support forTHREEDI_API_ACCESS_TOKENandTHREEDI_API_REFRESH_TOKENconfiguration variablesAdded a new, versioned, API in threedi_api_client.openapi / threedi_api_client.api.openapi.
A warning will be emitted if the old one is used (openapi_client).The API version should now be omitted from the API_HOST setting (e.g.https://api.3di.liveinstead ofhttps://api.3di.live/v3.0). A warning will be emitted if
a version is included.Make V3AlphaApi a subclass of V3BetaApi, and V3BetaApi a superset of V3Api.Added aretriesto theThreediApiwhich enables setting a retry policy.
For the async client,aiohttp_retryis included.Changed the defaulttimeoutof asynchronous file down/upload from 5 minutes total to
only socket timeouts of 5 seconds. This allows upload of larger files.Changed the default socket readtimeoutof uploads from 5 seconds to 10 minutes
to accomodate large file uploads.3.0.29 (2021-06-02)Moved documentation to readthedocs and consistently named the project from
threedi-api-client (instead of threedi-openapi-client).3.0.28 (2021-05-04)Renamed general settings to physical settings.3.0.27 (2021-04-26)Dropped support for Python 3.5.Added upload and download file functions (sync and async).3.0.26 (2021-04-07)Put leakage back. Was missing because local API definition was out of sync.3.0.25 (2021-04-07)Added simulation settings.3.0.24 (2021-03-19)Added leakage to API3.0.23 (2021-03-03)Removed print statement.3.0.22 (2021-02-12)Fix: The expiry function for automatic token renewal did not work.3.0.21 (2021-01-21)New filters and usage statistics models.3.0.20 (2021-01-07)Fix threedi_api_client import.3.0.19 (2021-01-07)Run pytest withpython -m pyest…to make sure the current path is added to the PYTHONPATH.3.0.18 (2021-01-07)Make sure aio module is distributed as well.3.0.17 (2020-12-01)Added boundary conditions (file) upload3.0.16 (2020-11-04)Pinned aiohttp to 3.6.3,  with >= 3.7.0 yarl and mulitdict
needs to be build with GCC.Removed laterals/file/upload endpointAdded endpoint for retrying Lizard (results) postprocessing3.0.15 (2020-10-14)Added user to lizardrasterrain and lizard raster sources&sinks3.0.14 (2020-10-14)Retrying release3.0.13 (2020-10-14)Added extent/point swagger definitionsAdded filelateral to swagger3.0.12 (2020-10-13)Retrying release3.0.11 (2020-10-13)Added user to Lizard raster rain and Lizard raster sources sinksAdded gh-actions release pipeline.3.0.10 (2020-09-29)Added bulk-lateral events.3.0.9 (2020-09-16)Added table and memory structure controls.3.0.8 (2020-09-04)Renamed timestructurecontrol to timestructurecontrols.3.0.7 (2020-08-20)Add example notebooks in the documentation.3.0.6 (2020-07-31)Update exit code definitions.3.0.5 (2020-07-31)Added exit_code field to status resource.Added breaches graph endpoint.3.0.4 (2020-07-15)Added pumps discharge graph endpointAdded more filtering options on contracts3.0.4b3 (2020-07-10)Added id field everywhere3.0.4b2 (2020-07-08)Generated with generator version v4.3.0Fixed problem with threedimodel on simulation resource (was integer should be string)3.0.4b1 (2020-07-07)Damage estimation is not required3.0.3 (2020-06-16)Changed Lizard postprocessing overview endpoint3.0.2 (2020-06-12)Username filters for simulations endpoint.3.0.1 (2020-06-09)Added statistics endpointChanged Lizard post-processing endpoint
(not backwards compatible, however intended to be used only by Lizard)3.0 (2020-05-25)Official production release3.0.b24 (2020-05-22)All uid fields on events should be read-only3.0.b23 (2020-05-20)Added wind global drag coefficient3.0.b22 (2020-05-18)Added max_rate to actions3.0.b21 (2020-05-15)Status field crash_report has become detail.3.0.b20 (2020-05-11)Added breaches and more fields to potentialbreaches3.0.b19 (2020-04-24)File filter exclude/include simulation status.3.0.b18 (2020-04-24)Added ‘active’ to inpy-version resource3.0.b17 (2020-04-20)Added icontains filters3.0.b16 (2020-04-10)Added uuid field to initial saved state serializer.3.0.b15 (2020-04-01)Added simulation websocket channels overview endpoints3.0.b14 (2020-03-23)Added raster-edits processing endpoints3.0.b13 (2020-03-20)Split up waterlevel graph endpoint in
waterflow and waterlevel graph endpointAdded waterprofile graph endpoint3.0.b12 (2020-03-10)Added waterlevel graph endpoint3.0.b11 (2020-03-06)Added users endpointChanged user endpoint to profile endpointAdded more filters3.0b10 (2020-02-19)Simulation model now has a ‘tags’ field.3.0.b9 (2020-02-12)Support for interactive simulations.Result API endpoints.3.0.b8 (2020-02-10)Edit Constant and Timeseries Wind events3.0.b7 (2020-02-03)Added windAdded visualization endpoints3.0.b6 (2020-01-29)Something went wrong with the 3.0.b5 release, next rty.3.0.b5 (2020-01-27)Raster edits, event uuids.3.0.b4 (2019-12-12)Local rain events.3.0.b3 (2019-12-09)Less strict requirement for dependencies ‘six’ and ‘urllib3’ to
avoid pipenv resolve issues at Lizard3.0.b2 (2019-12-02)Changed ‘set_pump_discharge’ to ‘set_pump_capacity’.3.0.b1 (2019-11-28)Updated API descriptionsRaster resource filtering3.0.b0 (2019-11-28)First 3.0 release candidateAll swagger schema’s are automatically saved in
schemas/swagger_xxx.yaml0.0.23 (2019-11-26)Fixing releases0.0.22 (2019-11-26)Addedinitialwaterlevel rastersandpostprocessing0.0.21 (2019-11-18)Fixed ThreediApiClient constructor not working with config keywords and
.env file.Added initial waterlevels0.0.20 (2019-11-11)Addedsimulationandsimulation_idto statuses serializer.Automatically get a new JWT token when
the current one is valid less than 5 minutes.Usemkdocsfor documentation.0.0.17.3 (2019-11-04)Test release.0.0.17.2 (2019-11-04)Test release.0.0.17.1 (2019-11-01)Add boundary model.0.0.17c (2019-11-01)Added boundaries to simulation events and updated docs.0.0.17b (2019-10-31)Bulk boundary conditions.0.0.17a (2019-10-31)Boundary conditions.0.0.17 (2019-10-30)Limit compatible python versions0.1.9 (2019-10-30)Added resourcestatuses.0.1.8 (2019-10-17)Added timed control0.1.7 (2019-09-25)Laterals now have id field.Usage integration0.1.6 (2019-09-04)Added geojson/gridadmin/rasters upload & download0.1.5 (2019-07-03)Updated file uploading0.1.4 (2019-06-24)Include modules.0.1.3 (2019-06-24)Fix package name0.1.2 (2019-06-24)PyPi release.0.1.1 (2019-06-21)Included more endpoints0.1.0 (2019-05-10)First release on PyPI.