This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!
%package -n python3-vortexasdk
Summary: Vortexa SDK
Provides: python-vortexasdk
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-vortexasdk
# VortexaSDK
[](https://circleci.com/gh/VorTECHsa/python-sdk)
[](https://github.com/psf/black)
[](#contributors)
Welcome to Vortexa's Python Software Development Kit (SDK)! We built the SDK to
provide fast, interactive, programmatic exploration of our data. The tool lets
Data Scientists, Analysts and Developers efficiently explore the worldβs
waterborne oil movements, and to build custom models & reports with minimum
setup cost.
The SDK sits as a thin python wrapper around
[Vortexa's API](https://docs.vortexa.com), giving you immediate access to pandas
DataFrames.
##### Example
In an interactive Python console, run:
```python
>>> from datetime import datetime
>>> from vortexasdk import CargoMovements
>>> df = CargoMovements()\
.search(filter_activity='loading_state',
filter_time_min=datetime(2017, 8, 2),
filter_time_max=datetime(2017, 8, 3))\
.to_df()
```
returns:
| | quantity | vessels.0.name | product.group.label | product.grade.label | events.cargo_port_load_event.0.end_timestamp | events.cargo_port_unload_event.0.start_timestamp |
| --: | -------: | :------------- | :------------------ | :------------------ | :------------------------------------------- | :----------------------------------------------- |
| 0 | 1998 | ALSIA SWAN | Clean products | Lube Oils | 2017-08-01T06:10:45+0000 | 2017-08-27T14:38:15+0000 |
| 1 | 16559 | IVER | Dirty products | nan | 2017-08-02T17:20:51+0000 | 2017-09-07T07:52:20+0000 |
| 2 | 522288 | BLUE SUN | Crude | Gharib | 2017-08-02T04:22:09+0000 | 2017-08-13T10:32:09+0000 |
## Quick Start
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fcargo_movements.ipynb)
##### Installation
```bash
$ pip install vortexasdk
```
The SDK requires Python version 3.7 or above, see
[Setup FAQ](https://vortechsa.github.io/python-sdk/faq_setup/) for more details.
To install the SDK on an Apple ARM-based machine, use Python version to 3.8 or higher and use the latest version of pip. This is supported in the SDK versions 0.41.0 or higher.
##### Authentication
Set your `VORTEXA_API_KEY` environment variable, that's all. Alternatively, the
SDK prompts to you enter your API Key when running a script interactively.
To get an API key and experiment with Vortexa's data, you can
[request a demo here](https://www.vortexa.com/demo).
##### Check Setup
To check the SDK is setup correctly, run the following in a bash console:
```bash
$ python -m vortexasdk.check_setup
```
A successful setup looks like this:
## Next Steps
Learn how to call
[Endpoints](https://vortechsa.github.io/python-sdk/endpoints/about-endpoints/)
## Glossary
The Glossary can be found at
[Vortexa API Documentation](https://docs.vortexa.com). The Glossary outlines key
terms, functions and assumptions aimed at helping to extract powerful findings
from our data.
## Documentation
Read the documentation at
[VortexaSDK Docs](https://vortechsa.github.io/python-sdk/)
## Contributing
We welcome contributions! Please read our
[Contributing Guide](https://github.com/vortechsa/python-sdk/blob/master/CONTRIBUTING.md)
for ways to offer feedback and contributions.
Thanks goes to these wonderful contributors
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
