https://github.com/journy-io/python-sdk
🐍 The official Python SDK that you can use to easily interact with our API
https://github.com/journy-io/python-sdk
api python python3 sdk sdk-python
Last synced: 4 months ago
JSON representation
🐍 The official Python SDK that you can use to easily interact with our API
- Host: GitHub
- URL: https://github.com/journy-io/python-sdk
- Owner: journy-io
- License: mit
- Created: 2021-02-12T10:27:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-13T18:08:02.000Z (over 2 years ago)
- Last Synced: 2025-09-04T06:23:36.556Z (9 months ago)
- Topics: api, python, python3, sdk, sdk-python
- Language: Python
- Homepage: https://developers.journy.io/
- Size: 324 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://journy.io/?utm_source=github&utm_content=readme-python-sdk)
# journy.io Python SDK
[](https://pypi.org/project/journyio-sdk)  [](https://github.com/psf/black)
This is the official Python SDK for [journy.io](https://journy.io?utm_source=github&utm_content=readme-python-sdk).
## 💾 Installation
You can use the python package manager (`pip`) to install the SDK:
```bash
pip install journyio-sdk
```
## 🔌 Getting started
### Import
To start, first import the client.
```python
from journyio.client import Client, Config
```
### Configuration
To be able to use the journy.io SDK you need to generate an API key. If you don't have one you can create one
in [journy.io](https://system.journy.io?utm_source=github&utm_content=readme-python-sdk).
If you don't have an account yet, you can create one
in [journy.io](https://system.journy.io/register?utm_source=github&utm_content=readme-python-sdk)
or [request a demo first](https://www.journy.io/book-demo?utm_source=github&utm_content=readme-python-sdk).
Go to your settings, under the _Connections_-tab, to create and edit API keys. Make sure to give the correct permissions
to the API Key.
```python
from journyio.httpclient import HttpClientRequests
config = Config("api-key-secret")
http_client = HttpClientRequests() # If wanted, an own implementation of the HttpClient interface can be created
client = Client(http_client, config)
```
### Methods
#### Get API key details
```python
from journyio.results import Success
result = client.get_api_key_details()
if isinstance(result, Success):
print(result.request_id) # str
print(result.calls_remaining) # int
print(result.data) # ApiKeyDetails
print(result.permissions) # list of strings denoting the permissions
```
### Handling errors
Every call will return a `Success` or `Failure` object. `Success` objects refer to the call having succeeded (and
optionally containing data). A `Failure` object refers to the API returning an error. This can be any `APIError` (too
many requests, not found...). Our SDK only throws `JournyExceptions`, no other exceptions should be
called. `JournyExceptions` are provided with useful messages, which state where the error was made.
```python
from journyio.utils import JournyException
try:
result = client.get_tracking_snippet("www.journy.io")
if isinstance(result, Success):
print(result.request_id) # str
print(result.calls_remaining) # int
print(result.data) # TrackingSnippetResonse
else:
print(result.request_id) # str
print(result.calls_remaining) # int
print(result.error) # APIError
except JournyException as e:
print(e.msg) # str with error message
```
The request ID can be useful when viewing API logs
in [journy.io](https://system.journy.io?utm_source=github&utm_content=readme-python-sdk).
## 📬 API Docs
[API reference](https://developers.journy.io)
## 💯 Tests
To run the tests:
```bash
cd tests
pip install -r requirements.txt
pip install -U pytest
python scripts/createversion.py 0.0.0
pytest
```
## ❓ Help
We welcome your feedback, ideas and suggestions. We really want to make your life easier, so if we’re falling short or
should be doing something different, we want to hear about it.
Please create an issue or contact us via the chat on our website.
## 🔒 Security
If you discover any security related issues, please email security at journy io instead of using the issue tracker.