devo-sdk 6.0.0

Devo Software Development Kit for Python.

Devo Python SDK

This is the SDK to access Devo directly from Python. It can be used to:

• Send events and files to Devo.
• Make queries.
• Manage deferred tasks.

Requirements

The Devo SDK for Python requires Python 3.9+

Compatibility

• Tested compatibility for python 3.9, 3.10, 3.11 and 3.12

Quick Start

Installing the SDK

You can install the Devo SDK by using easy_install or pip:

# option 1
easy_install devo-sdk

# option 2
pip install devo-sdk

You can use sources files, cloning the project too:

# option 3
python setup.py install

# option 4
pip install .

# option 5 - dev option
pip install -e .

Documentation

There is specific documentation in the docs folder for each part of SDK:

• Sender
  • Data
  • Lookups
• Common
• API:
  • Api query
  • Api tasks management
    • Destination: email
    • Destination: redis
    • Destination: S3

Contributing

See PyLibs contributing guide.
Pull and merge requests are welcome ☺

Endpoints

Sender

To send data with Devo SDK, first choose the required endpoint depending on the region your are accessing from:

Region	Endpoint	Port
USA	collector-us.devo.io	443
Canada	collector-ca.devo.io	443
Europe	collector-eu.devo.io	443
APAC	collector-ap.devo.io	443

You have more information in the official documentation of Devo, Sending data to Devo.

API

To perform a request with API, first choose the required endpoint depending on the region your are accessing from:

Region	Endpoint
USA	https://apiv2-us.devo.com/search/query
Canada	https://apiv2-ca.devo.com/search/query
Europe	https://apiv2-eu.devo.com/search/query
APAC	https://api-apac.devo.com/search/query

You have more information in the official documentation of Devo, REST API.

Credentials

To obtain the access credentials necessary to use this SDK, you must have an account in DEVO.

Check the security credentials info for more details.

Certificates

You need use a three files (Cert, key and chain) to secure send data to Devo. Administrator users can find them in Administration → Credentials, in the X.509 tab.

API authorization

You can use a domain API key and API secret to sign the request. These are are a pair of credentials that every Devo account owns. Administrator users can find them in Administration → Credentials, in the Access Keys tab.

Launch tests

Pytest

The SDK uses Pytest for testing. This is a powerful tool for testing Python code. Pytest is a much more flexible and powerful tool than the built-in unittest module. It allows more testing functionality through the use of plugins. You can find more information in the Pytest documentation.

Install the testing requirements:

pip install -r requirements-test.txt

You can run tests from the tests folder of SDK

pytest

Its normal that TCP tests fails in clients or not Devo developers systems.

You can add the option --cov to create a coverage report.

pytest --cov

Check the pytest-cov documentation for more details.

The tests are divided into unit and integration tests. The integration tests require either a connection to Devo or to a local server that is launched when testing, so you need to have the environment variables in your system for all the tests that require connection to Devo can work.

To run the unit tests only, you can use the unit folder:

pytest unit

To run the integration tests only, you can use the integration folder:

pytest integration

You can also run the test for just one module. This is a useful feature if you are developing functionality in just one module.

pytest unit/test_sender_encoding.py

Contact Us

You can contact with us at [e-mail].

License

MIT License

(C) 2024 Devo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.