Skip to content

Add Pyhton example #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 19, 2024
Merged

Add Pyhton example #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
12d6cd6
Create pushData.py
tvolge Sep 2, 2024
37be80e
Update pushData.py
tvolge Sep 2, 2024
71fdb82
CR improvements
tvolge Sep 3, 2024
4001aea
update docs
tvolge Sep 10, 2024
06e64de
Changed example file name from camelcase to snakecase.
alekseimi Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 21 additions & 66 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,81 +45,36 @@ import databox

Execute `pytest` to run the tests.

## Getting Started
## Basic example

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import databox
from databox.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://push.databox.com
# See configuration.py for a list of all supported configuration parameters.
configuration = databox.Configuration(
host = "https://push.databox.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
# Configuration setup for the Databox API client
# The API token is used as the username for authentication
# It's recommended to store your API token securely, e.g., in an environment variable
configuration = databox.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
host = "https://push.databox.com",
username = "<YOUR-CUSTOM-DATA-TOKEN>",
password = ""
)

# It's crucial to specify the correct Accept header for the API request
with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client:
api_instance = databox.DefaultApi(api_client)

# Enter a context with an instance of the API client
with databox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = databox.DefaultApi(api_client)
# Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox
# The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point
push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }]

try:
api_instance.data_delete()
api_instance.data_post(push_data=push_data)
except ApiException as e:
print("Exception when calling DefaultApi->data_delete: %s\n" % e)

# Handle exceptions that occur during the API call, such as invalid data or authentication issues
pprint("API Exception occurred: %s\n" % e)
except Exception as e:
# Handle any other unexpected exceptions
pprint("An unexpected error occurred: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://push.databox.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**data_delete**](docs/DefaultApi.md#data_delete) | **DELETE** /data |
*DefaultApi* | [**data_metric_key_delete**](docs/DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} |
*DefaultApi* | [**data_post**](docs/DefaultApi.md#data_post) | **POST** /data |
*DefaultApi* | [**metrickeys_get**](docs/DefaultApi.md#metrickeys_get) | **GET** /metrickeys |
*DefaultApi* | [**metrickeys_post**](docs/DefaultApi.md#metrickeys_post) | **POST** /metrickeys |
*DefaultApi* | [**ping_get**](docs/DefaultApi.md#ping_get) | **GET** /ping |


## Documentation For Models

- [ApiResponse](docs/ApiResponse.md)
- [PushData](docs/PushData.md)
- [PushDataAttribute](docs/PushDataAttribute.md)
- [State](docs/State.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="basicAuth"></a>
### basicAuth

- **Type**: HTTP basic authentication


## Author




30 changes: 30 additions & 0 deletions examples/push_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import databox
from databox.rest import ApiException
from pprint import pprint

# Configuration setup for the Databox API client
# The API token is used as the username for authentication
# It's recommended to store your API token securely, e.g., in an environment variable
configuration = databox.Configuration(
host = "https://push.databox.com",
username = "<YOUR-CUSTOM-DATA-TOKEN>",
password = ""
)

# It's crucial to specify the correct Accept header for the API request
with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client:
api_instance = databox.DefaultApi(api_client)

# Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox
# The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point
push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }]

try:
api_instance.data_post(push_data=push_data)
except ApiException as e:
# Handle exceptions that occur during the API call, such as invalid data or authentication issues
pprint("API Exception occurred: %s\n" % e)
except Exception as e:
# Handle any other unexpected exceptions
pprint("An unexpected error occurred: %s\n" % e)

87 changes: 21 additions & 66 deletions src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,81 +45,36 @@ import databox

Execute `pytest` to run the tests.

## Getting Started
## Basic example

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import databox
from databox.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://push.databox.com
# See configuration.py for a list of all supported configuration parameters.
configuration = databox.Configuration(
host = "https://push.databox.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
# Configuration setup for the Databox API client
# The API token is used as the username for authentication
# It's recommended to store your API token securely, e.g., in an environment variable
configuration = databox.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
host = "https://push.databox.com",
username = "<YOUR-CUSTOM-DATA-TOKEN>",
password = ""
)

# It's crucial to specify the correct Accept header for the API request
with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client:
api_instance = databox.DefaultApi(api_client)

# Enter a context with an instance of the API client
with databox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = databox.DefaultApi(api_client)
# Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox
# The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point
push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }]

try:
api_instance.data_delete()
api_instance.data_post(push_data=push_data)
except ApiException as e:
print("Exception when calling DefaultApi->data_delete: %s\n" % e)

# Handle exceptions that occur during the API call, such as invalid data or authentication issues
pprint("API Exception occurred: %s\n" % e)
except Exception as e:
# Handle any other unexpected exceptions
pprint("An unexpected error occurred: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://push.databox.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**data_delete**](docs/DefaultApi.md#data_delete) | **DELETE** /data |
*DefaultApi* | [**data_metric_key_delete**](docs/DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} |
*DefaultApi* | [**data_post**](docs/DefaultApi.md#data_post) | **POST** /data |
*DefaultApi* | [**metrickeys_get**](docs/DefaultApi.md#metrickeys_get) | **GET** /metrickeys |
*DefaultApi* | [**metrickeys_post**](docs/DefaultApi.md#metrickeys_post) | **POST** /metrickeys |
*DefaultApi* | [**ping_get**](docs/DefaultApi.md#ping_get) | **GET** /ping |


## Documentation For Models

- [ApiResponse](docs/ApiResponse.md)
- [PushData](docs/PushData.md)
- [PushDataAttribute](docs/PushDataAttribute.md)
- [State](docs/State.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="basicAuth"></a>
### basicAuth

- **Type**: HTTP basic authentication


## Author




30 changes: 0 additions & 30 deletions src/docs/ApiResponse.md
View file
Open in desktop

This file was deleted.

Loading