Package: devo-sdk
Devo Python SDKThis 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.RequirementsThe Devo SDK for Python requires Python 3.8+CompatibilityTested compatibility for python 3.8 and 3.9Quick StartInstalling the SDKYou can install the Devo SDK by usingeasy_installorpip:#option1easy_install devo-sdk#option2pip install devo-sdkYou can use sources files, cloning the project too:#option3python setup.py install#option4pip install .#option5-devoptionpip install -e .DocumentationThere is specific documentation in thedocsfolder for each part of SDK:SenderDataLookupsCommonAPI:Api queryApi tasks managementDestination: emailDestination: redisDestination: S3ContributingSeePyLibs contributing guide.Pull and merge requests are welcome ☺EndpointsSenderTo send data with Devo SDK, first choose the required endpoint depending on the region your are accessing from:RegionEndpointPortUSAcollector-us.devo.io443Canadacollector-ca.devo.io443Europecollector-eu.devo.io443APACcollector-ap.devo.io443You have more information in the official documentation of Devo,Sending data to Devo.APITo perform a request with API, first choose the required endpoint depending on the region your are accessing from:RegionEndpointUSAhttps://apiv2-us.devo.com/search/queryCanadahttps://apiv2-ca.devo.com/search/queryEuropehttps://apiv2-eu.devo.com/search/queryAPAChttps://api-apac.devo.com/search/queryYou have more information in the official documentation of Devo,REST API.CredentialsTo obtain the access credentials necessary to use this SDK, you must have an account inDEVO.Check thesecurity credentialsinfo for more details.CertificatesYou need use a three files (Cert, key and chain) to secure send data to Devo.
Administrator users can find them inAdministration→Credentials, in the X.509 tab.API authorizationYou 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 inAdministration→Credentials, in the Access Keys tab.Launch testsPytestThe 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 thePytest documentation.Install the testing requirements:~/projects/devo-python-sdk > pip install -r requirements-test.txtYou can run tests from thetestsfolder of SDK~/projects/devo-python-sdk/tests > pytestIts normal that TCP tests fails in clients or not Devo developers systems.You can add the option--covto create a coverage report.~/projects/devo-python-sdk/tests > pytest --covCheck thepytest-cov documentationfor 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 theunitfolder:~/projects/devo-python-sdk/tests > pytest unitTo run the integration tests only, you can use theintegrationfolder:~/projects/devo-python-sdk/tests > pytest integrationYou can also run the test for just one module. This is a useful feature if you are developing functionality in just one module.~/projects/devo-python-sdk/tests > pytest unit/test_sender_encoding.pyContact UsYou can contact with us atsupport@devo.com.LicenseMIT 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.