upstream-api-client 0.1.9

Upstream Sensor Storage

upstream-api-client

Sensor Storage for Upstream data

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 0.1.9
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Updating the Generated Client

This repository is automatically generated from the OpenAPI specification. To update the client when the API changes:

1. Download the latest openapi.json from the API server and save it in the root directory
2. Run the generator using Docker (requires Docker to be installed):

   make openapi
   

3. Build the package:

   python -m build
   

4. Upload to PyPI:

   twine upload dist/* --config-file ~/.pypirc
   

Setting up PyPI credentials

Create a ~/.pypirc file with your PyPI credentials:

[distutils]
index-servers =
    pypi

[pypi]
username = __token__
password = pypi-your-api-token-here

Replace pypi-your-api-token-here with your actual PyPI API token. You can generate tokens at https://pypi.org/manage/account/token/.

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install upstream-api-client

(you may need to run pip with root permission: sudo pip install git+https://github.com/In-For-Disaster-Analytics/upstream-python-api-client.git)

Then import the package:

import upstream_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import upstream_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import upstream_api_client
from upstream_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = upstream_api_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with upstream_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = upstream_api_client.AuthApi(api_client)
    username = 'username_example' # str |
    password = 'password_example' # str |
    grant_type = 'grant_type_example' # str |  (optional)
    scope = '' # str |  (optional) (default to '')
    client_id = 'client_id_example' # str |  (optional)
    client_secret = 'client_secret_example' # str |  (optional)

    try:
        # Login
        api_response = api_instance.login_api_v1_token_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
        print("The response of AuthApi->login_api_v1_token_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->login_api_v1_token_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	login_api_v1_token_post	POST /api/v1/token	Login
CampaignsApi	create_campaign_api_v1_campaigns_post	POST /api/v1/campaigns	Create Campaign
CampaignsApi	delete_sensor_api_v1_campaigns_campaign_id_delete	DELETE /api/v1/campaigns/{campaign_id}	Delete Sensor
CampaignsApi	get_campaign_api_v1_campaigns_campaign_id_get	GET /api/v1/campaigns/{campaign_id}	Get Campaign
CampaignsApi	list_campaigns_api_v1_campaigns_get	GET /api/v1/campaigns	List Campaigns
CampaignsApi	partial_update_campaign_api_v1_campaigns_campaign_id_patch	PATCH /api/v1/campaigns/{campaign_id}	Partial Update Campaign
CampaignsApi	update_campaign_api_v1_campaigns_campaign_id_put	PUT /api/v1/campaigns/{campaign_id}	Update Campaign
MeasurementsApi	create_measurement_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_post	POST /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements	Create Measurement
MeasurementsApi	delete_sensor_measurements_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_delete	DELETE /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements	Delete Sensor Measurements
MeasurementsApi	get_measurements_with_confidence_intervals_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_confidence_intervals_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements/confidence-intervals	Get Measurements With Confidence Intervals
MeasurementsApi	get_sensor_measurements_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements	Get Sensor Measurements
MeasurementsApi	partial_update_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_measurement_id_patch	PATCH /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements/{measurement_id}	Partial Update Sensor
MeasurementsApi	update_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_measurements_measurement_id_put	PUT /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/measurements/{measurement_id}	Update Sensor
ProjectsApi	get_project_members_for_user_api_v1_projects_project_id_members_get	GET /api/v1/projects/{project_id}/members	Get Project Members For User
ProjectsApi	get_projects_api_v1_projects_get	GET /api/v1/projects	Get Projects
SensorVariablesApi	list_sensor_variables_api_v1_sensor_variables_get	GET /api/v1/sensor_variables	List Sensor Variables
SensorsApi	delete_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_delete	DELETE /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors	Delete Sensor
SensorsApi	force_update_sensor_statistics_api_v1_campaigns_campaign_id_stations_station_id_sensors_statistics_post	POST /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/statistics	Force Update Sensor Statistics
SensorsApi	force_update_single_sensor_statistics_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_statistics_post	POST /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}/statistics	Force Update Single Sensor Statistics
SensorsApi	get_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}	Get Sensor
SensorsApi	list_sensors_api_v1_campaigns_campaign_id_stations_station_id_sensors_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors	List Sensors
SensorsApi	partial_update_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_patch	PATCH /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}	Partial Update Sensor
SensorsApi	update_sensor_api_v1_campaigns_campaign_id_stations_station_id_sensors_sensor_id_put	PUT /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/{sensor_id}	Update Sensor
StationsApi	create_station_api_v1_campaigns_campaign_id_stations_post	POST /api/v1/campaigns/{campaign_id}/stations	Create Station
StationsApi	delete_sensor_api_v1_campaigns_campaign_id_stations_delete	DELETE /api/v1/campaigns/{campaign_id}/stations	Delete Sensor
StationsApi	export_measurements_csv_api_v1_campaigns_campaign_id_stations_station_id_measurements_export_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/measurements/export	Export Measurements Csv
StationsApi	export_sensors_csv_api_v1_campaigns_campaign_id_stations_station_id_sensors_export_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}/sensors/export	Export Sensors Csv
StationsApi	get_station_api_v1_campaigns_campaign_id_stations_station_id_get	GET /api/v1/campaigns/{campaign_id}/stations/{station_id}	Get Station
StationsApi	list_stations_api_v1_campaigns_campaign_id_stations_get	GET /api/v1/campaigns/{campaign_id}/stations	List Stations
StationsApi	partial_update_station_api_v1_campaigns_campaign_id_stations_station_id_patch	PATCH /api/v1/campaigns/{campaign_id}/stations/{station_id}	Partial Update Station
StationsApi	update_station_api_v1_campaigns_campaign_id_stations_station_id_put	PUT /api/v1/campaigns/{campaign_id}/stations/{station_id}	Update Station
UploadfileCsvApi	post_sensor_and_measurement_api_v1_uploadfile_csv_campaign_campaign_id_station_station_id_sensor_post	POST /api/v1/uploadfile_csv/campaign/{campaign_id}/station/{station_id}/sensor	Post Sensor And Measurement

Documentation For Models

• AggregatedMeasurement
• Bbox
• CampaignCreateResponse
• CampaignUpdate
• CampaignsIn
• Coordinates
• ForceUpdateSensorStatisticsResponse
• GetCampaignResponse
• GetSensorResponse
• GetStationResponse
• HTTPValidationError
• ListCampaignsResponseItem
• ListCampaignsResponsePagination
• ListMeasurementsResponsePagination
• ListSensorsResponsePagination
• ListStationsResponsePagination
• Location
• LoginResponse
• MeasurementCreateResponse
• MeasurementIn
• MeasurementItem
• MeasurementUpdate
• Point
• PyTASAllocation
• PyTASPi
• PyTASProject
• PyTASUser
• SensorCreateResponse
• SensorItem
• SensorStatistics
• SensorSummaryForStations
• SensorUpdate
• SortField
• StationCreate
• StationCreateResponse
• StationItemWithSummary
• StationType
• StationUpdate
• StationsListResponseItem
• SummaryGetCampaign
• SummaryListCampaigns
• UpdateSensorStatisticsResponse
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Author

[e-mail]