Skip to main content

Vortexa SDK

Project description

VortexaSDK

Code style: black All 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, giving you immediate access to pandas DataFrames.

Example

In an interactive Python console, run:

>>> 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:

Binder

Installation

pip install vortexasdk

or

pip3 install vortexasdk

The SDK requires Python version 3.9. See Setup FAQ for more details.

To install the SDK on an Apple ARM-based machine, use Python versions 3.9 and use the latest version of pip. This is supported in the SDK versions 1.0.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.

Check Setup

To check the SDK is setup correctly, run the following in a bash console:

python -m vortexasdk.check_setup

or

python3 -m vortexasdk.check_setup

A successful setup looks like this:

check_setup.png

Next Steps

Learn how to call Endpoints

Glossary

The Glossary can be found at Vortexa API Documentation. 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

Contributing

We welcome contributions! Please read our Contributing Guide for ways to offer feedback and contributions.

Thanks goes to these wonderful contributors (emoji key):


Kit Burgess

🎨 💻

tinovs

💻 👀

David Andrew Starkey

💻 📖 💡

syed

👀

Jakub Korzeniowski

🤔

Edward Wright

📓

Patrick Roddy

📓

Romain

📓 🤔

Natday

💼 🤔 📓

ArthurD1

📓

Chloe Connor

📓

Achilleas Sfakianakis

📓

Sean Barry

💻 📖

Konrad Moskal

💻

Pawel Pietruszka

💻

Olly De Sousa

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Project details


Release history Release notifications | RSS feed

This version

1.0.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vortexasdk-1.0.9.tar.gz (155.9 kB view details)

Uploaded Source

Built Distribution

vortexasdk-1.0.9-py3-none-any.whl (297.4 kB view details)

Uploaded Python 3

File details

Details for the file vortexasdk-1.0.9.tar.gz.

File metadata

  • Download URL: vortexasdk-1.0.9.tar.gz
  • Upload date:
  • Size: 155.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.0

File hashes

Hashes for vortexasdk-1.0.9.tar.gz
Algorithm Hash digest
SHA256 04f1d4e66221c48366af6ba88146655da92f7345361c3ff059708ed49bc9912e
MD5 7c23867b3f7229dea3befa582f60e30f
BLAKE2b-256 d1b77c979b35473d6c073516cffe127a075bef34e2ce83d94a451fadef483ad6

See more details on using hashes here.

File details

Details for the file vortexasdk-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: vortexasdk-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 297.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.0

File hashes

Hashes for vortexasdk-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 dfacc5f7c08c6232fbc604d96ece652720874751e5b5ca8cff7638589cdb5369
MD5 09c9f6ff8a552df1363f696dfdccf376
BLAKE2b-256 e3027bf255b0e0bd2baf4c6a54925511c06b401c80eb728de73c11cf41d442be

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page