vortexasdk 0.28.2__tar.gz → 0.36.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/CHANGELOG.md +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/CODE_OF_CONDUCT.md +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/CONTRIBUTING.md +29 -20
- vortexasdk-0.36.2/LICENSE +201 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/MANIFEST.in +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/PKG-INFO +57 -41
- vortexasdk-0.36.2/README.md +134 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/docs/__init__.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/docs/autogen.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/docs/utils.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/pyproject.toml +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/setup.cfg +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/setup.py +14 -13
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/__init__.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/__init__.py +0 -0
- vortexasdk-0.36.2/tests/api/examples/asset_tanks.json +203 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/attributes.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/cargo_event_entity1.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/cargo_movements.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/cargo_time_series.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/corporate_entity1.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/corporate_entity2.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/corporations.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/geography_entity1.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/geography_reference.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/product_entity1.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/products.json +0 -0
- vortexasdk-0.36.2/tests/api/examples/storage_terminals.json +173 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/vessel_entity1.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/vessel_movements.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/vessels.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/examples/vessels_reference.json +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_cargo_event_entity.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_cargo_movement.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_corporate_entity.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_from_dict_mixin.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_geography_entity.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_product_entity.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_vessel_entity.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/api/test_vessel_movement.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/config.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/conversions/__init__.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/conversions/test_conversions.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/conversions/test_convert_vessels.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/__init__.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_asset_tanks.py +33 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_attributes.py +8 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_attributes_real.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_availability.py +46 -0
- vortexasdk-0.36.2/tests/endpoints/test_availability_breakdown.py +16 -0
- vortexasdk-0.36.2/tests/endpoints/test_availability_timeseries.py +23 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_cargo_movements_real.py +32 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_cargo_time_series.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_cargo_time_series_real.py +38 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_corporations_real.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_corporations_search_result.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_destination_breakdown.py +135 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_eia_forecasts_real.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_freight_pricing_search.py +49 -0
- vortexasdk-0.36.2/tests/endpoints/test_freight_pricing_timeseries.py +40 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_geographies_real.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_onshore_inventories_search.py +30 -0
- vortexasdk-0.36.2/tests/endpoints/test_onshore_inventories_timeseries.py +66 -0
- vortexasdk-0.36.2/tests/endpoints/test_origin_breakdown.py +135 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_products.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_products_real.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_reference_endpoints_real.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_storage_terminals.py +33 -0
- vortexasdk-0.28.2/tests/endpoints/test_ton_miles_breakdown_real.py → vortexasdk-0.36.2/tests/endpoints/test_tonne_miles_breakdown_real.py +7 -8
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_avg_distance_timeseries.py +49 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_capacity_timeseries.py +46 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_destination_breakdown.py +65 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_origin_breakdown.py +65 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_quantity_timeseries.py +48 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_speed_breakdown.py +129 -0
- vortexasdk-0.36.2/tests/endpoints/test_utilisation_timeseries.py +49 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_vessel_movements_real.py +10 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_vessels.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_vessels_real.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/endpoints/test_vessels_search_result.py +0 -0
- vortexasdk-0.36.2/tests/endpoints/test_voyages_congestion_breakdown.py +115 -0
- vortexasdk-0.36.2/tests/endpoints/test_voyages_search_enriched.py +82 -0
- vortexasdk-0.36.2/tests/endpoints/test_voyages_timeseries.py +45 -0
- vortexasdk-0.36.2/tests/endpoints/test_voyages_top_hits.py +124 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/mock_client.py +17 -11
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_client.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_id.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_operations.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_to_ISODate.py +0 -0
- vortexasdk-0.36.2/tests/test_to_ISODate_Array.py +15 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_utils.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_version_proposals.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/test_versioning.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/testcases.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/tests/timer.py +0 -0
- vortexasdk-0.36.2/vortexasdk/__init__.py +42 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/abstract_client.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/__init__.py +6 -0
- vortexasdk-0.36.2/vortexasdk/api/aggregation_breakdown_item.py +20 -0
- vortexasdk-0.36.2/vortexasdk/api/asset_tank.py +44 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/attribute.py +0 -0
- vortexasdk-0.36.2/vortexasdk/api/breakdown_item.py +23 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/cargo_movement.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/corporation.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/eia_forecast.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/entity_flattening.py +9 -1
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/entity_serializing.py +0 -0
- vortexasdk-0.36.2/vortexasdk/api/freight_pricing.py +24 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/geography.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/id.py +0 -0
- vortexasdk-0.36.2/vortexasdk/api/onshore_inventory.py +32 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/product.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/search_result.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/serdes.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/shared_types.py +7 -3
- vortexasdk-0.36.2/vortexasdk/api/storage_terminal.py +35 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/timeseries_item.py +2 -2
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/vessel.py +0 -0
- vortexasdk-0.36.2/vortexasdk/api/vessel_availability.py +59 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/api/vessel_movement.py +0 -2
- vortexasdk-0.36.2/vortexasdk/api/voyages.py +164 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/check_setup.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/client.py +45 -14
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/config.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/__init__.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/conversions.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/corporations.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/geographies.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/products.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/conversions/vessels.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/__init__.py +33 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/aggregation_breakdown_result.py +47 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/asset_tanks.py +111 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/asset_tanks_result.py +42 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/attributes.py +1 -1
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/attributes_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/breakdown_result.py +88 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/cargo_movements.py +10 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/cargo_movements_result.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/cargo_timeseries.py +24 -9
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/corporations.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/corporations_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/destination_breakdown.py +240 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/eia_forecasts.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/eia_forecasts_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/endpoints.py +43 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_avg_distance_timeseries.py +249 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_capacity_timeseries.py +242 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_destination_breakdown.py +230 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_origin_breakdown.py +231 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_quantity_timeseries.py +248 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_speed_breakdown.py +236 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/fleet_utilisation_timeseries.py +244 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/freight_pricing_result.py +107 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/freight_pricing_search.py +92 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/freight_pricing_timeseries.py +91 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/geographies.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/geographies_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/onshore_inventories_result.py +112 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/onshore_inventories_search.py +148 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/onshore_inventories_timeseries.py +153 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/origin_breakdown.py +240 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/products.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/products_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/reference_breakdown_result.py +85 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/storage_terminals.py +97 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/storage_terminals_result.py +42 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/timeseries_result.py +0 -0
- vortexasdk-0.28.2/vortexasdk/endpoints/ton_miles_breakdown.py → vortexasdk-0.36.2/vortexasdk/endpoints/tonne_miles_breakdown.py +7 -7
- vortexasdk-0.36.2/vortexasdk/endpoints/vessel_availability_breakdown.py +183 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/vessel_availability_result.py +221 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/vessel_availability_search.py +197 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/vessel_availability_timeseries.py +197 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/vessel_movements.py +7 -3
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/vessel_movements_result.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/vessels.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/endpoints/vessels_result.py +0 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_congestion_breakdown.py +283 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_congestion_breakdown_result.py +129 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_search_enriched.py +304 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_search_enriched_result.py +57 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_timeseries.py +284 -0
- vortexasdk-0.36.2/vortexasdk/endpoints/voyages_top_hits.py +315 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/exceptions.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/logger.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/operations.py +6 -2
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/result_conversions.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/retry_session.py +1 -1
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/utils.py +15 -0
- vortexasdk-0.36.2/vortexasdk/version.py +1 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk/version_utils.py +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk.egg-info/PKG-INFO +57 -41
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk.egg-info/SOURCES.txt +69 -3
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk.egg-info/dependency_links.txt +0 -0
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk.egg-info/requires.txt +12 -8
- {vortexasdk-0.28.2 → vortexasdk-0.36.2}/vortexasdk.egg-info/top_level.txt +0 -0
- vortexasdk-0.28.2/README.md +0 -118
- vortexasdk-0.28.2/vortexasdk/__init__.py +0 -20
- vortexasdk-0.28.2/vortexasdk/endpoints/__init__.py +0 -11
- vortexasdk-0.28.2/vortexasdk/endpoints/endpoints.py +0 -16
- vortexasdk-0.28.2/vortexasdk/version.py +0 -1
|
File without changes
|
|
File without changes
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
# Contributing to VortexaSDK
|
|
2
2
|
|
|
3
|
-
|
|
4
3
|
## Suggesting new features / Reporting An Issue
|
|
5
4
|
|
|
6
5
|
First, check to see if there's an existing issue/pull request for the
|
|
@@ -10,11 +9,11 @@ https://github.com/vortechsa/python-sdk/pulls.
|
|
|
10
9
|
If there isn't an existing issue there, please file an issue. The
|
|
11
10
|
ideal report includes:
|
|
12
11
|
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
- A description of the problem/suggestion.
|
|
13
|
+
- How to recreate the bug (including the version on your python interpreter).
|
|
14
|
+
- If possible, create a pull request with a (failing) test case
|
|
15
|
+
demonstrating what's wrong. This makes the process for fixing bugs
|
|
16
|
+
quicker & gets issues resolved sooner.
|
|
18
17
|
|
|
19
18
|
## Setting up your environment
|
|
20
19
|
|
|
@@ -26,23 +25,27 @@ $ cd python-sdk
|
|
|
26
25
|
```
|
|
27
26
|
|
|
28
27
|
create a new virtual environment
|
|
28
|
+
|
|
29
29
|
```bash
|
|
30
30
|
$ python3.7 -m venv venv
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
activate your environment
|
|
34
|
+
|
|
34
35
|
```bash
|
|
35
36
|
$ . venv/bin/activate
|
|
36
37
|
```
|
|
37
38
|
|
|
38
39
|
install the required dependencies
|
|
40
|
+
|
|
39
41
|
```
|
|
40
42
|
$ pip install -e '.[tests]'
|
|
41
43
|
```
|
|
42
44
|
|
|
43
|
-
To run the live tests, you'll need to have the `VORTEXA_API_KEY` environment variable set
|
|
45
|
+
To run the live tests, you'll need to have the `VORTEXA_API_KEY` environment variable set - `export VORTEXA_API_KEY=xyz`
|
|
44
46
|
|
|
45
47
|
run tests
|
|
48
|
+
|
|
46
49
|
```
|
|
47
50
|
$ python setup.py test
|
|
48
51
|
```
|
|
@@ -50,27 +53,30 @@ $ python setup.py test
|
|
|
50
53
|
If you're just looking to run tests in a single module (`test_vessels` in this case), you can do like this:
|
|
51
54
|
|
|
52
55
|
```bash
|
|
53
|
-
$ pytest -v tests/endpoints/test_vessels.py
|
|
56
|
+
$ pytest -v tests/endpoints/test_vessels.py
|
|
54
57
|
```
|
|
55
58
|
|
|
56
59
|
Run all the 'try-me-out' notebooks, and then clear the cell outputs so the data isn't publicly visible.
|
|
60
|
+
|
|
57
61
|
```bash
|
|
58
|
-
jupyter nbconvert --to notebook --inplace --execute docs/examples/try_me_out/*.ipynb
|
|
59
|
-
jupyter nbconvert --to notebook --inplace --clear-output docs/examples/try_me_out/*.ipynb
|
|
62
|
+
jupyter nbconvert --to notebook --inplace --execute docs/examples/try_me_out/*.ipynb
|
|
63
|
+
jupyter nbconvert --to notebook --inplace --clear-output docs/examples/try_me_out/*.ipynb
|
|
60
64
|
```
|
|
61
65
|
|
|
62
66
|
Serve documentation locally
|
|
67
|
+
|
|
63
68
|
```bash
|
|
64
69
|
$ ./docs/scripts/serve_docs.sh
|
|
65
70
|
```
|
|
71
|
+
|
|
66
72
|
…and view the docs at http://localhost:8000 in your web browser.
|
|
67
73
|
|
|
68
74
|
Install the git [pre-commit-hooks](https://pre-commit.com/#3-install-the-git-hook-scripts)
|
|
75
|
+
|
|
69
76
|
```bash
|
|
70
77
|
$ pre-commit install
|
|
71
78
|
```
|
|
72
79
|
|
|
73
|
-
|
|
74
80
|
:tada: Now you're ready to create a new branch, add a feature or fix a bug, then send us a pull request! :tada:
|
|
75
81
|
|
|
76
82
|
## Contributing Code
|
|
@@ -84,6 +90,7 @@ The python-sdk follow strict semver, so you'll need to increment the MAJOR nunbe
|
|
|
84
90
|
a breaking change, the MINOR number if you're addind a new feature, or PATCH number if you've introduced a bug fix.
|
|
85
91
|
|
|
86
92
|
Once your branch is merged to master, CircleCI will do a few things:
|
|
93
|
+
|
|
87
94
|
- Deploy the new package to pypi https://pypi.org/project/vortexasdk/, using the version in `version.py`.
|
|
88
95
|
- Update the github pages documentation at https://vortechsa.github.io/python-sdk/
|
|
89
96
|
- Create a git tag, usign the version in `version.py`
|
|
@@ -91,15 +98,17 @@ Once your branch is merged to master, CircleCI will do a few things:
|
|
|
91
98
|
### Pull requests:
|
|
92
99
|
|
|
93
100
|
A good pull request:
|
|
94
|
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
+
|
|
102
|
+
- Is clear.
|
|
103
|
+
- Follows the existing style of the code base (PEP-8).
|
|
104
|
+
- Has comments included as needed.
|
|
105
|
+
- A test case that demonstrates the previous flaw that now passes with
|
|
106
|
+
the included patch, or demonstrates the newly added feature.
|
|
107
|
+
- If it adds/changes a public API, it must also include documentation
|
|
108
|
+
for those changes.
|
|
101
109
|
|
|
102
110
|
Tips:
|
|
111
|
+
|
|
103
112
|
- If you're adding a new endpoint, adapt and use `./docs/generate_stubs.sh` to generate sample json data used for tests.
|
|
104
113
|
|
|
105
114
|
### Contributing Jupyter Notebooks
|
|
@@ -109,16 +118,16 @@ Please include the version of the SDK and any other packages used to generate th
|
|
|
109
118
|
## Style guide
|
|
110
119
|
|
|
111
120
|
#### Commit message formatting
|
|
112
|
-
We adopt the [Conventional Commits](https://www.conventionalcommits.org) convention to format commit messages.
|
|
113
121
|
|
|
122
|
+
We adopt the [Conventional Commits](https://www.conventionalcommits.org) convention to format commit messages.
|
|
114
123
|
|
|
115
124
|
#### Documentation
|
|
125
|
+
|
|
116
126
|
We're using [Pydocmd](https://github.com/NiklasRosenstein/pydoc-markdown)
|
|
117
127
|
to automatically generate docs.
|
|
118
128
|
|
|
119
129
|
Documentation should follow the [Google Documentation Style Guide](https://developers.google.com/style/api-reference-comments)
|
|
120
130
|
|
|
121
|
-
|
|
122
131
|
## Community
|
|
123
132
|
|
|
124
133
|
Discussions about the VortexaSDK take place on this repository's https://github.com/vortechsa/python-sdk/issues and https://github.com/vortechsa/python-sdk/pulls sections. Anybody is welcome to join these conversations.
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
File without changes
|
|
@@ -1,23 +1,26 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: vortexasdk
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.36.2
|
|
4
4
|
Summary: Vortexa SDK
|
|
5
5
|
Home-page: https://github.com/vortechsa/python-sdk
|
|
6
6
|
Author: Vortexa Developers
|
|
7
7
|
Author-email: developers@vortexa.com
|
|
8
8
|
License: Apache License 2.0
|
|
9
9
|
Description: # VortexaSDK
|
|
10
|
+
|
|
10
11
|
[](https://circleci.com/gh/VorTECHsa/python-sdk)
|
|
11
12
|
[](https://github.com/psf/black)
|
|
12
13
|
[](#contributors)
|
|
13
14
|
|
|
14
|
-
Welcome to Vortexa's Python Software Development Kit (SDK)!
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
giving you immediate access to pandas DataFrames.
|
|
15
|
+
Welcome to Vortexa's Python Software Development Kit (SDK)! We built the SDK to
|
|
16
|
+
provide fast, interactive, programmatic exploration of our data. The tool lets
|
|
17
|
+
Data Scientists, Analysts and Developers efficiently explore the world’s
|
|
18
|
+
waterborne oil movements, and to build custom models & reports with minimum
|
|
19
|
+
setup cost.
|
|
20
20
|
|
|
21
|
+
The SDK sits as a thin python wrapper around
|
|
22
|
+
[Vortexa's API](https://docs.vortexa.com), giving you immediate access to pandas
|
|
23
|
+
DataFrames.
|
|
21
24
|
|
|
22
25
|
##### Example
|
|
23
26
|
|
|
@@ -32,14 +35,14 @@ Description: # VortexaSDK
|
|
|
32
35
|
filter_time_max=datetime(2017, 8, 3))\
|
|
33
36
|
.to_df()
|
|
34
37
|
```
|
|
35
|
-
returns:
|
|
36
38
|
|
|
37
|
-
|
|
38
|
-
|---:|-----------:|:-----------------|:----------------------|:----------------------|:-----------------------------------------------|:---------------------------------------------------|
|
|
39
|
-
| 0 | 1998 | ALSIA SWAN | Clean products | Lube Oils | 2017-08-01T06:10:45+0000 | 2017-08-27T14:38:15+0000 |
|
|
40
|
-
| 1 | 16559 | IVER | Dirty products | nan | 2017-08-02T17:20:51+0000 | 2017-09-07T07:52:20+0000 |
|
|
41
|
-
| 2 | 522288 | BLUE SUN | Crude | Gharib | 2017-08-02T04:22:09+0000 | 2017-08-13T10:32:09+0000 |
|
|
39
|
+
returns:
|
|
42
40
|
|
|
41
|
+
| | 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 |
|
|
42
|
+
| --: | -------: | :------------- | :------------------ | :------------------ | :------------------------------------------- | :----------------------------------------------- |
|
|
43
|
+
| 0 | 1998 | ALSIA SWAN | Clean products | Lube Oils | 2017-08-01T06:10:45+0000 | 2017-08-27T14:38:15+0000 |
|
|
44
|
+
| 1 | 16559 | IVER | Dirty products | nan | 2017-08-02T17:20:51+0000 | 2017-09-07T07:52:20+0000 |
|
|
45
|
+
| 2 | 522288 | BLUE SUN | Crude | Gharib | 2017-08-02T04:22:09+0000 | 2017-08-13T10:32:09+0000 |
|
|
43
46
|
|
|
44
47
|
## Quick Start
|
|
45
48
|
|
|
@@ -53,15 +56,16 @@ Description: # VortexaSDK
|
|
|
53
56
|
$ pip install vortexasdk
|
|
54
57
|
```
|
|
55
58
|
|
|
56
|
-
The SDK requires Python version 3.7 or above, see
|
|
59
|
+
The SDK requires Python version 3.7 or above, see
|
|
60
|
+
[Setup FAQ](https://vortechsa.github.io/python-sdk/faq_setup/) for more details.
|
|
57
61
|
|
|
58
62
|
##### Authentication
|
|
59
63
|
|
|
60
|
-
Set your `VORTEXA_API_KEY` environment variable, that's all.
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
To get an API key and experiment with Vortexa's data, you can [request a demo here](https://www.vortexa.com/request-demo-sdk).
|
|
64
|
+
Set your `VORTEXA_API_KEY` environment variable, that's all. Alternatively, the
|
|
65
|
+
SDK prompts to you enter your API Key when running a script interactively.
|
|
64
66
|
|
|
67
|
+
To get an API key and experiment with Vortexa's data, you can
|
|
68
|
+
[request a demo here](https://www.vortexa.com/demo).
|
|
65
69
|
|
|
66
70
|
##### Check Setup
|
|
67
71
|
|
|
@@ -75,55 +79,67 @@ Description: # VortexaSDK
|
|
|
75
79
|
|
|
76
80
|

|
|
77
81
|
|
|
78
|
-
|
|
79
82
|
## Next Steps
|
|
80
83
|
|
|
81
|
-
Learn how to call
|
|
84
|
+
Learn how to call
|
|
85
|
+
[Endpoints](https://vortechsa.github.io/python-sdk/endpoints/about-endpoints/)
|
|
82
86
|
|
|
83
87
|
## Glossary
|
|
84
88
|
|
|
85
|
-
The Glossary can be found at
|
|
86
|
-
|
|
87
|
-
|
|
89
|
+
The Glossary can be found at
|
|
90
|
+
[Vortexa API Documentation](https://docs.vortexa.com). The Glossary outlines key
|
|
91
|
+
terms, functions and assumptions aimed at helping to extract powerful findings
|
|
92
|
+
from our data.
|
|
88
93
|
|
|
89
94
|
## Documentation
|
|
90
95
|
|
|
91
|
-
Read the documentation at
|
|
96
|
+
Read the documentation at
|
|
97
|
+
[VortexaSDK Docs](https://vortechsa.github.io/python-sdk/)
|
|
92
98
|
|
|
93
99
|
## Contributing
|
|
94
100
|
|
|
95
|
-
We welcome contributions! Please read our
|
|
101
|
+
We welcome contributions! Please read our
|
|
102
|
+
[Contributing Guide](https://github.com/vortechsa/python-sdk/blob/master/CONTRIBUTING.md)
|
|
103
|
+
for ways to offer feedback and contributions.
|
|
96
104
|
|
|
97
|
-
Thanks goes to these wonderful contributors
|
|
105
|
+
Thanks goes to these wonderful contributors
|
|
106
|
+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
98
107
|
|
|
99
108
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
100
109
|
<!-- prettier-ignore-start -->
|
|
101
110
|
<!-- markdownlint-disable -->
|
|
102
111
|
<table>
|
|
103
112
|
<tr>
|
|
104
|
-
<td align="center"><a href="http://vortexa.com/"><img src="https://avatars1.githubusercontent.com/u/33626692?v=4" width="100px;" alt=""/><br /><sub><b>Kit Burgess</b></sub></a><br /><a href="#design-KitBurgess" title="Design">🎨</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=KitBurgess" title="Code">💻</a></td>
|
|
105
|
-
<td align="center"><a href="https://github.com/cvonsteg"><img src="https://avatars2.githubusercontent.com/u/28671095?v=4" width="100px;" alt=""/><br /><sub><b>tinovs</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=cvonsteg" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/pulls?q=is%3Apr+reviewed-by%3Acvonsteg" title="Reviewed Pull Requests">👀</a></td>
|
|
106
|
-
<td align="center"><a href="http://star-www.st-and.ac.uk/~ds207/"><img src="https://avatars3.githubusercontent.com/u/11855684?v=4" width="100px;" alt=""/><br /><sub><b>David Andrew Starkey</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=dstarkey23" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=dstarkey23" title="Documentation">📖</a> <a href="#example-dstarkey23" title="Examples">💡</a></td>
|
|
107
|
-
<td align="center"><a href="https://github.com/syed1992"><img src="https://avatars2.githubusercontent.com/u/45287337?v=4" width="100px;" alt=""/><br /><sub><b>syed</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/pulls?q=is%3Apr+reviewed-by%3Asyed1992" title="Reviewed Pull Requests">👀</a></td>
|
|
108
|
-
<td align="center"><a href="https://www.vortexa.com/"><img src="https://avatars0.githubusercontent.com/u/503380?v=4" width="100px;" alt=""/><br /><sub><b>Jakub Korzeniowski</b></sub></a><br /><a href="#ideas-kujon" title="Ideas, Planning, & Feedback">🤔</a></td>
|
|
109
|
-
<td align="center"><a href="https://github.com/eadwright"><img src="https://avatars0.githubusercontent.com/u/17048626?v=4" width="100px;" alt=""/><br /><sub><b>Edward Wright</b></sub></a><br /><a href="#userTesting-eadwright" title="User Testing">📓</a></td>
|
|
110
|
-
<td align="center"><a href="https://paddyroddy.github.io/"><img src="https://avatars3.githubusercontent.com/u/15052188?v=4" width="100px;" alt=""/><br /><sub><b>Patrick Roddy</b></sub></a><br /><a href="#userTesting-paddyroddy" title="User Testing">📓</a></td>
|
|
113
|
+
<td align="center"><a href="http://vortexa.com/"><img src="https://avatars1.githubusercontent.com/u/33626692?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kit Burgess</b></sub></a><br /><a href="#design-KitBurgess" title="Design">🎨</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=KitBurgess" title="Code">💻</a></td>
|
|
114
|
+
<td align="center"><a href="https://github.com/cvonsteg"><img src="https://avatars2.githubusercontent.com/u/28671095?v=4?s=100" width="100px;" alt=""/><br /><sub><b>tinovs</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=cvonsteg" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/pulls?q=is%3Apr+reviewed-by%3Acvonsteg" title="Reviewed Pull Requests">👀</a></td>
|
|
115
|
+
<td align="center"><a href="http://star-www.st-and.ac.uk/~ds207/"><img src="https://avatars3.githubusercontent.com/u/11855684?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Andrew Starkey</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=dstarkey23" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=dstarkey23" title="Documentation">📖</a> <a href="#example-dstarkey23" title="Examples">💡</a></td>
|
|
116
|
+
<td align="center"><a href="https://github.com/syed1992"><img src="https://avatars2.githubusercontent.com/u/45287337?v=4?s=100" width="100px;" alt=""/><br /><sub><b>syed</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/pulls?q=is%3Apr+reviewed-by%3Asyed1992" title="Reviewed Pull Requests">👀</a></td>
|
|
117
|
+
<td align="center"><a href="https://www.vortexa.com/"><img src="https://avatars0.githubusercontent.com/u/503380?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jakub Korzeniowski</b></sub></a><br /><a href="#ideas-kujon" title="Ideas, Planning, & Feedback">🤔</a></td>
|
|
118
|
+
<td align="center"><a href="https://github.com/eadwright"><img src="https://avatars0.githubusercontent.com/u/17048626?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Edward Wright</b></sub></a><br /><a href="#userTesting-eadwright" title="User Testing">📓</a></td>
|
|
119
|
+
<td align="center"><a href="https://paddyroddy.github.io/"><img src="https://avatars3.githubusercontent.com/u/15052188?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Patrick Roddy</b></sub></a><br /><a href="#userTesting-paddyroddy" title="User Testing">📓</a></td>
|
|
120
|
+
</tr>
|
|
121
|
+
<tr>
|
|
122
|
+
<td align="center"><a href="https://github.com/rugg2"><img src="https://avatars3.githubusercontent.com/u/37453675?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Romain</b></sub></a><br /><a href="#userTesting-rugg2" title="User Testing">📓</a> <a href="#ideas-rugg2" title="Ideas, Planning, & Feedback">🤔</a></td>
|
|
123
|
+
<td align="center"><a href="https://github.com/Natday"><img src="https://avatars3.githubusercontent.com/u/38128493?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Natday</b></sub></a><br /><a href="#business-Natday" title="Business development">💼</a> <a href="#ideas-Natday" title="Ideas, Planning, & Feedback">🤔</a> <a href="#userTesting-Natday" title="User Testing">📓</a></td>
|
|
124
|
+
<td align="center"><a href="https://github.com/ArthurD1"><img src="https://avatars0.githubusercontent.com/u/44548105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ArthurD1</b></sub></a><br /><a href="#userTesting-ArthurD1" title="User Testing">📓</a></td>
|
|
125
|
+
<td align="center"><a href="https://github.com/ChloeConnor"><img src="https://avatars2.githubusercontent.com/u/42340891?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chloe Connor</b></sub></a><br /><a href="#userTesting-ChloeConnor" title="User Testing">📓</a></td>
|
|
126
|
+
<td align="center"><a href="https://www.vortexa.com/"><img src="https://avatars1.githubusercontent.com/u/31421156?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Achilleas Sfakianakis</b></sub></a><br /><a href="#userTesting-asfakianakis" title="User Testing">📓</a></td>
|
|
127
|
+
<td align="center"><a href="https://seanbarry.dev"><img src="https://avatars0.githubusercontent.com/u/7374449?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sean Barry</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=SeanBarry" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=SeanBarry" title="Documentation">📖</a></td>
|
|
128
|
+
<td align="center"><a href="https://github.com/dufia"><img src="https://avatars1.githubusercontent.com/u/5569649?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Konrad Moskal</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=dufia" title="Code">💻</a></td>
|
|
111
129
|
</tr>
|
|
112
130
|
<tr>
|
|
113
|
-
<td align="center"><a href="
|
|
114
|
-
<td align="center"><a href="https://github.com/Natday"><img src="https://avatars3.githubusercontent.com/u/38128493?v=4" width="100px;" alt=""/><br /><sub><b>Natday</b></sub></a><br /><a href="#business-Natday" title="Business development">💼</a> <a href="#ideas-Natday" title="Ideas, Planning, & Feedback">🤔</a> <a href="#userTesting-Natday" title="User Testing">📓</a></td>
|
|
115
|
-
<td align="center"><a href="https://github.com/ArthurD1"><img src="https://avatars0.githubusercontent.com/u/44548105?v=4" width="100px;" alt=""/><br /><sub><b>ArthurD1</b></sub></a><br /><a href="#userTesting-ArthurD1" title="User Testing">📓</a></td>
|
|
116
|
-
<td align="center"><a href="https://github.com/ChloeConnor"><img src="https://avatars2.githubusercontent.com/u/42340891?v=4" width="100px;" alt=""/><br /><sub><b>Chloe Connor</b></sub></a><br /><a href="#userTesting-ChloeConnor" title="User Testing">📓</a></td>
|
|
117
|
-
<td align="center"><a href="https://www.vortexa.com/"><img src="https://avatars1.githubusercontent.com/u/31421156?v=4" width="100px;" alt=""/><br /><sub><b>Achilleas Sfakianakis</b></sub></a><br /><a href="#userTesting-asfakianakis" title="User Testing">📓</a></td>
|
|
118
|
-
<td align="center"><a href="https://seanbarry.dev"><img src="https://avatars0.githubusercontent.com/u/7374449?v=4" width="100px;" alt=""/><br /><sub><b>Sean Barry</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=SeanBarry" title="Code">💻</a> <a href="https://github.com/VorTECHsa/python-sdk/commits?author=SeanBarry" title="Documentation">📖</a></td>
|
|
131
|
+
<td align="center"><a href="http://pawelpietruszka.net"><img src="https://avatars0.githubusercontent.com/u/17066202?v=4" width="100px;" alt=""/><br /><sub><b>Pawel Pietruszka</b></sub></a><br /><a href="https://github.com/VorTECHsa/python-sdk/commits?author=Selerski" title="Code">💻</a></td>
|
|
119
132
|
</tr>
|
|
120
133
|
</table>
|
|
121
134
|
|
|
122
|
-
<!-- markdownlint-
|
|
135
|
+
<!-- markdownlint-restore -->
|
|
123
136
|
<!-- prettier-ignore-end -->
|
|
137
|
+
|
|
124
138
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
125
139
|
|
|
126
|
-
This project follows the
|
|
140
|
+
This project follows the
|
|
141
|
+
[all-contributors](https://github.com/all-contributors/all-contributors)
|
|
142
|
+
specification. Contributions of any kind welcome!
|
|
127
143
|
|
|
128
144
|
Platform: UNKNOWN
|
|
129
145
|
Classifier: Programming Language :: Python :: 3.7
|