opengate-data

Opengate-data

Opengate-data is a python library that helps you integrate OpenGate into your python projects.

Installation

To install the library, run:

pip install opengate-data

Import

To import the OpenGateClient, use:

from opengate_data import OpenGateClient

Basic use with user and password

To initialize the OpenGateClient using a username and password:

client = OpenGateClient(url="Url", user="User", password="Password")

Basic use with api-key

To initialize the client using an api_key:

client = OpenGateClient(url="Url", api_key="Api_Key")

Basic use api-key with .env

To initialize the client using an api_key with a .env file.

1. Create a .env file with the following content:

   API_KEY="api-key"
   

2. Load the environment variable and initialize the client:

   from dotenv import load_dotenv
   from pathlib import Path
   
   # Load the environment variable
   env_path = Path(".") / ".env"
   load_dotenv(dotenv_path=env_path)
   
   client = OpenGateClient(url="Url")
   # or
   client = OpenGateClient(url=None)
   

In this case, you can either set api_key to None or simply omit it, as the client will automatically retrieve the API_KEY from the environment variable when needed. If you are connecting to internal services, such as those in K8s, you can set the URL to None or omit it entirely, similar to the examples provided for K8s usage.

Basic use of api-key with an environment variable

To initialize the client using an api_key from an environment variable, you can set the api_key directly in your environment without relying on a .env:

1. Create environment variable

   • On UNIX systems, use:

     export API_KEY="your-api-key"
     

   • On Windows, use:

     set API_KEY="your-api-key"
     

2. Initialize the client.

   client = OpenGateClient(url="Url")
   # or
   client = OpenGateClient(url="Url", api_key=None)
   

Similar to the previous example, you can set api_key to None or omit it, as the client will automatically retrieve the value from the environment variable. Additionally, you can also authenticate using a username and password by specifying those credentials instead. If you are connecting to internal services, such as those in K8s, you can set the URL to None or omit it entirely, similar to the examples provided for K8s usage.

Basic use without url for services K8s

To initialize the OpenGateClient without specifying a URL, you can either omit the URL parameter or set it to None

client = OpenGateClient(api_key="Api_Key")
# or
client = OpenGateClient(url=None, api_key="Api_Key")

Similar to the previous examples, you have the option to provide the api_key directly, set it to None, or omit it altogether. If you choose to omit it, the client will automatically retrieve the api_key from the environment variable if it is set. Additionally, you can also authenticate using a username and password by specifying those credentials instead.

Features

The library consists of the following modules:

• IA
  • Models
  • Pipelines
  • Transformers
• Collection
  • Collection
  • Bulk Collection
• Provision
  • Asset
  • Bulk
  • Devices
  • Processor
• Rules
  • Rules
• Searching
  • Datapoints
  • Data sets
  • Entities
  • Operations
  • Rules
  • Timeseries

Documentation

To generate the API documentation you can execute ./generate_doc.sh and open the generated Markdown on: docs/documentation.md

Basic Examples of the OpenGate-Data Modules

The examples of the different modules are found in the path docs/basic_examples.md

Additional Documentation

For more details and examples about each of the modules, consult the complete documentation.

Generate version

To configure uploading packages to PyPI, you need to create and set up the .pypirc file in your home directory. Below are the steps for different operating systems:

• Windows: notepad $env:USERPROFILE\.pypirc.
• Linux: nano ~/.pypirc.

Inside the .pypirc file, configure the following lines, replacing token with your actual PyPI API token:

[pypi]
     username = __token__
     password = token

Open the setup.py file and update the version of your project as needed. After updating the version in setup.py, run the following script to build and upload your package to PyPI: ./dish.sh

Test

Running All Tests

If you want to run all the tests, both unit and integration tests, you can execute the pytest.ini file. Run the following command in your terminal: pytest

Running Unit Tests

Inside the unit folder, you will find all the unit tests corresponding to each module. These tests verify the functionality of each function individually. To run a unit test, use the pytest command followed by the name of the unit test. For example: pytest test_iot_collection.py

Running Integration Tests

Inside the test/features, you will find all the integration tests. Additionally, you need to add the url and api_key to the test_steps_cucumber.py file

To run the tests, use the following command: pytest test_steps_cucumber.py

License

This project is licensed under the MIT License.