RIPE Atlas Cousteau
===================
|Documentation| |Build Status| |Code Health| |PYPI Version| |Python Versions| |Python Implementations| |Python Format|
A Python wrapper around the RIPE ATLAS API.
Installation
------------
$ pip install ripe.atlas.cousteau
Docs
----
Complete documentation can be found on `Read the Docs`_.
.. _Read the Docs: http://ripe-atlas-cousteau.readthedocs.org/en/latest/
Name
----
But why `Cousteau`_? The RIPE Atlas team decided to name all of its
modules after explorers, and this is not an exception :)
.. _Cousteau: http://en.wikipedia.org/wiki/Jacques_Cousteau
.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-cousteau.png?branch=master
:target: https://travis-ci.org/RIPE-NCC/ripe-atlas-cousteau
.. |Code Health| image:: https://landscape.io/github/RIPE-NCC/ripe-atlas-cousteau/master/landscape.png
:target: https://landscape.io/github/RIPE-NCC/ripe-atlas-cousteau/master
.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.cousteau.svg
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.cousteau.svg
.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.cousteau.svg
.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.cousteau.svg
.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-cousteau/badge/?version=latest
:target: https://ripe-atlas-cousteau.readthedocs.org/en/latest/?badge=latest
Releases History
================
2.0.0 (release 2023-01-20)
--------------------------
Changes:
~~~~~~~~
- The AtlasStream class has been updated to use the new WebSocket interface
- AtlasStream objects can now be iterated as an alternative to using callbacks
- There used to be both start_stream() and subscribe() methods which did the same thing,
except that start_stream() had extra validation. This extra validation has been
added to subscribe(), and start_stream() is now an alias to it.
- bind_channel() was renamed to bind(), although it is maintained as an alias, and
there is a corresponding unbind() to remove a callback
- Deprecated event aliases were dropped, you have to use full event names like
"atlas_result" and "atlas_metadata" when binding
1.5.1 (release 2022-05-23)
--------------------------
Bug Fixes:
~~~~~~~~~~~~~
- Make it possible to instantiate AtlasMeasurement directly by passing in a "type" value in the spec
1.5.0 (released 2022-02-23)
---------------------------
Changes:
~~~~~~~~
- Drop support for old Python versions (>= 3.6 supported)
- Documentation fixes
- Use python-socketio instead of socketIO-client for streaming
- Include an 'unsubscribe' method on AtlasStream, as well as constants for currently available event names
- Update testing framework to use pytest
1.4.2 (released 2018-03-22)
---------------------------
New features:
~~~~~~~~~~~~~
- Add support for tagging and untagging measurements
1.4.1 (released 2018-01-08)
---------------------------
Changes:
~~~~~~~~
- Minor fixes
1.4 (released 2017-04-21)
-------------------------
New features:
~~~~~~~~~~~~~
- Expose `bill_to` option for measurement creation
- Enable User-Agent for stream connections
Changes:
~~~~~~~~
- Update stream channel names to new naming scene in the background
Bug Fixes:
~~~~~~~~~~
- Fix bug where stream was not reconnected after a disconnect
- Fix unicode cases on the stream spotted by @JonasGroeger
1.3 (released 2016-10-21)
-------------------------
Changes:
~~~~~~~~
- Improved streaming support:
- Introduce error handling
- Channels errors binded by default
- Introduced debug mode
- Update features set. See all here https://atlas.ripe.net/docs/result-streaming/
- Deprecated short events name and local event name checking. See the event names here https://atlas.ripe.net/docs/result-streaming/
- Introduced support for proxies and additional headers
- Timezone aware objects for measurement meta data
1.2 (released 2016-03-02)
-------------------------
Changes:
~~~~~~~~
- Backwards incompatible field changes on the Measurement object:
- destination_address -> target_ip
- destination_asn -> target_asn
- destination_name -> target
1.1 (released 2016-02-09)
-------------------------
New features:
~~~~~~~~~~~~~
- Start supporting Anchors listing API.
- Brand new documentation hosted on readthedocs.
Changes:
~~~~~~~~
- Various refactorings to clean up codebase.
1.0.7 (released 2016-01-13)
---------------------------
Changes:
~~~~~~~~
- Backwards compatible change of the format we expect for measurement type to handle upcoming change in the API.
Bug Fixes:
~~~~~~~~~~
- Fix bug when creating stream for probes connection channel. Updating also wrong documentation.
1.0.6 (released 2015-12-15)
---------------------------
Changes:
~~~~~~~~
- Add copyright text everywhere for debian packaging.
1.0.5 (released 2015-12-14)
---------------------------
Changes:
~~~~~~~~
- Add tests to the package itself.
- Make user-agent changeable by the user.
- Various refactorings.
1.0.4 (released 2015-11-06)
---------------------------
Changes:
~~~~~~~~
- Handle both string/dictionary as input for probe_ids filter for Result and LatestResult requests.
1.0.2 (released 2015-10-26)
---------------------------
Bug Fixes:
~~~~~~~~~~
- Fix bug where key parameter was added to the url even if it was empty.
- Fix bug where we didn't try to unjson 4xx responses even if they could contain json structure.
1.0.1 (released 2015-10-23)
---------------------------
Changes:
~~~~~~~~
- Now we conform to new API feature that allows for specifying tags when adding probes to existing measurements
Bug Fixes:
~~~~~~~~~~
- Fix bug we didn't allow user to specify single tag include/exclude.
1.0 (released 2015-10-21)
-------------------------
New features:
~~~~~~~~~~~~~
- Add support for include/exclude tags in changing sources requests.
- Add support for latest results API call.
- Implement HTTP measurement creation.
- Support for python 3 (<=3.4).
- Support for pypy/pypy3.
- Support for wheels format.
Changes:
~~~~~~~~
- Migrate all Atlas requests to use requests library and refactor a lot of code to have a cleaner version.
- Create an API v2 translator to address several option name changing. A deprecation warning will be given.
Bug Fixes:
~~~~~~~~~~
- Fix bug where python representation of measurements without a stop time was exploding.
- Make sure start/stop timestamps in measurement create request are always in UTC.
0.10.1 (released 2015-10-06)
----------------------------
New features:
~~~~~~~~~~~~~
- Implement support for object return in the request generators for probe/measurement.
Changes:
~~~~~~~~
- Probe/Measurement python representation takes meta data from v2 API as well. Now everything should point to v2 API.
0.10 (released 2015-10-01)
--------------------------
New features:
~~~~~~~~~~~~~
- add object representation of meta data for a probe or a measurement.
Changes:
~~~~~~~~
- Abandon v1 RIPE ATLAS API and use only v2.
Bug Fixes:
~~~~~~~~~~
- Fix bug that prevented users from specifying all possible source types when they tried to add more probes to existing measurements.
- Cover case where a user specified really long list of probes/measurements in the ProbeRequest/MeasurementRequest that was causing 'HTTP ERROR 414: Request-URI Too Long'. Additionally, now if API returns error raise an exception instead of stopping iteration.
0.9.2 (released 2015-09-21)
---------------------------
Changes:
~~~~~~~~
- Small refactor of Stream class and manually enforce websockets in SocketIO client
0.9.1 (released 2015-09-03)
---------------------------
Bug Fixes:
~~~~~~~~~~
- Fix bug related to binding result atlas stream.
0.9 (released 2015-09-01)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for fetching real time results using RIPE Atlas stream server.
- this version and on will be available on PYPI.
0.8 (released 2015-08-31)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for NTP measurements.
0.7 (released 2015-06-03)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for fetching probes/measurements meta data using python generators.
0.6 (released 2014-06-17)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for querying results based on start/end time, msm_id and probe id.
Changes:
~~~~~~~~
- add http agent according to package version to all requests.
0.5 (released 2014-05-22)
-------------------------
Changes:
~~~~~~~~
- change package structure to comply with the new structure of atlas packages
- add continuous integration support
- add tests
- enable travis
- enable code health checks
- add required files for uploading to github
0.4 (released 2014-03-31)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for stopping a measurement.
0.3 (released 2014-02-25)
-------------------------
New features:
~~~~~~~~~~~~~
- add simple support for HTTP GET queries.
0.2 (released 2014-02-03)
-------------------------
New features:
~~~~~~~~~~~~~
- add support for adding/removing probes API request.
Changes:
~~~~~~~~
- use AtlasCreateRequest instead of AtlasRequest for creating a new measurement.
0.1 (released 2014-01-21)
-------------------------
- Initial release.
Raw data
{
"_id": null,
"home_page": "https://github.com/RIPE-NCC/ripe-atlas-cousteau",
"name": "ripe.atlas.cousteau",
"maintainer": "The RIPE Atlas Team",
"docs_url": null,
"requires_python": "",
"maintainer_email": "atlas@ripe.net",
"keywords": "RIPE,RIPE NCC,RIPE Atlas",
"author": "The RIPE Atlas Team",
"author_email": "atlas@ripe.net",
"download_url": "",
"platform": null,
"description": "RIPE Atlas Cousteau\n===================\n\n|Documentation| |Build Status| |Code Health| |PYPI Version| |Python Versions| |Python Implementations| |Python Format|\n\nA Python wrapper around the RIPE ATLAS API.\n\nInstallation\n------------\n\n$ pip install ripe.atlas.cousteau\n\nDocs\n----\nComplete documentation can be found on `Read the Docs`_.\n\n.. _Read the Docs: http://ripe-atlas-cousteau.readthedocs.org/en/latest/\n\nName\n----\nBut why `Cousteau`_? The RIPE Atlas team decided to name all of its\nmodules after explorers, and this is not an exception :)\n\n.. _Cousteau: http://en.wikipedia.org/wiki/Jacques_Cousteau\n.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-cousteau.png?branch=master\n :target: https://travis-ci.org/RIPE-NCC/ripe-atlas-cousteau\n.. |Code Health| image:: https://landscape.io/github/RIPE-NCC/ripe-atlas-cousteau/master/landscape.png\n :target: https://landscape.io/github/RIPE-NCC/ripe-atlas-cousteau/master\n.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.cousteau.svg\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.cousteau.svg\n.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.cousteau.svg\n.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.cousteau.svg\n.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-cousteau/badge/?version=latest\n :target: https://ripe-atlas-cousteau.readthedocs.org/en/latest/?badge=latest\n\n\n\nReleases History\n================\n\n2.0.0 (release 2023-01-20)\n--------------------------\nChanges:\n~~~~~~~~\n- The AtlasStream class has been updated to use the new WebSocket interface\n- AtlasStream objects can now be iterated as an alternative to using callbacks\n- There used to be both start_stream() and subscribe() methods which did the same thing,\n except that start_stream() had extra validation. This extra validation has been\n added to subscribe(), and start_stream() is now an alias to it.\n- bind_channel() was renamed to bind(), although it is maintained as an alias, and\n there is a corresponding unbind() to remove a callback\n- Deprecated event aliases were dropped, you have to use full event names like\n \"atlas_result\" and \"atlas_metadata\" when binding\n\n1.5.1 (release 2022-05-23)\n--------------------------\nBug Fixes:\n~~~~~~~~~~~~~\n- Make it possible to instantiate AtlasMeasurement directly by passing in a \"type\" value in the spec\n\n1.5.0 (released 2022-02-23)\n---------------------------\nChanges:\n~~~~~~~~\n- Drop support for old Python versions (>= 3.6 supported)\n- Documentation fixes\n- Use python-socketio instead of socketIO-client for streaming\n- Include an 'unsubscribe' method on AtlasStream, as well as constants for currently available event names\n- Update testing framework to use pytest\n\n1.4.2 (released 2018-03-22)\n---------------------------\nNew features:\n~~~~~~~~~~~~~\n- Add support for tagging and untagging measurements\n\n1.4.1 (released 2018-01-08)\n---------------------------\nChanges:\n~~~~~~~~\n- Minor fixes\n\n1.4 (released 2017-04-21)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- Expose `bill_to` option for measurement creation\n- Enable User-Agent for stream connections\n\nChanges:\n~~~~~~~~\n - Update stream channel names to new naming scene in the background\n\nBug Fixes:\n~~~~~~~~~~\n- Fix bug where stream was not reconnected after a disconnect\n- Fix unicode cases on the stream spotted by @JonasGroeger\n\n1.3 (released 2016-10-21)\n-------------------------\nChanges:\n~~~~~~~~\n- Improved streaming support:\n\n - Introduce error handling\n - Channels errors binded by default\n - Introduced debug mode\n - Update features set. See all here https://atlas.ripe.net/docs/result-streaming/\n - Deprecated short events name and local event name checking. See the event names here https://atlas.ripe.net/docs/result-streaming/\n\n- Introduced support for proxies and additional headers\n- Timezone aware objects for measurement meta data\n\n1.2 (released 2016-03-02)\n-------------------------\nChanges:\n~~~~~~~~\n- Backwards incompatible field changes on the Measurement object:\n\n - destination_address -> target_ip\n - destination_asn -> target_asn\n - destination_name -> target\n\n1.1 (released 2016-02-09)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- Start supporting Anchors listing API.\n- Brand new documentation hosted on readthedocs.\n\nChanges:\n~~~~~~~~\n- Various refactorings to clean up codebase.\n\n1.0.7 (released 2016-01-13)\n---------------------------\nChanges:\n~~~~~~~~\n- Backwards compatible change of the format we expect for measurement type to handle upcoming change in the API.\n\nBug Fixes:\n~~~~~~~~~~\n- Fix bug when creating stream for probes connection channel. Updating also wrong documentation.\n\n1.0.6 (released 2015-12-15)\n---------------------------\nChanges:\n~~~~~~~~\n- Add copyright text everywhere for debian packaging.\n\n1.0.5 (released 2015-12-14)\n---------------------------\nChanges:\n~~~~~~~~\n- Add tests to the package itself.\n- Make user-agent changeable by the user.\n- Various refactorings.\n\n1.0.4 (released 2015-11-06)\n---------------------------\nChanges:\n~~~~~~~~\n- Handle both string/dictionary as input for probe_ids filter for Result and LatestResult requests.\n\n1.0.2 (released 2015-10-26)\n---------------------------\nBug Fixes:\n~~~~~~~~~~\n- Fix bug where key parameter was added to the url even if it was empty.\n- Fix bug where we didn't try to unjson 4xx responses even if they could contain json structure.\n\n1.0.1 (released 2015-10-23)\n---------------------------\nChanges:\n~~~~~~~~\n- Now we conform to new API feature that allows for specifying tags when adding probes to existing measurements\n\nBug Fixes:\n~~~~~~~~~~\n- Fix bug we didn't allow user to specify single tag include/exclude.\n\n1.0 (released 2015-10-21)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- Add support for include/exclude tags in changing sources requests.\n- Add support for latest results API call.\n- Implement HTTP measurement creation.\n- Support for python 3 (<=3.4).\n- Support for pypy/pypy3.\n- Support for wheels format.\n\nChanges:\n~~~~~~~~\n- Migrate all Atlas requests to use requests library and refactor a lot of code to have a cleaner version.\n- Create an API v2 translator to address several option name changing. A deprecation warning will be given.\n\nBug Fixes:\n~~~~~~~~~~\n- Fix bug where python representation of measurements without a stop time was exploding. \n- Make sure start/stop timestamps in measurement create request are always in UTC.\n\n0.10.1 (released 2015-10-06)\n----------------------------\nNew features:\n~~~~~~~~~~~~~\n- Implement support for object return in the request generators for probe/measurement.\n\nChanges:\n~~~~~~~~\n- Probe/Measurement python representation takes meta data from v2 API as well. Now everything should point to v2 API.\n\n0.10 (released 2015-10-01)\n--------------------------\nNew features:\n~~~~~~~~~~~~~\n- add object representation of meta data for a probe or a measurement.\n\nChanges:\n~~~~~~~~\n- Abandon v1 RIPE ATLAS API and use only v2.\n\nBug Fixes:\n~~~~~~~~~~\n- Fix bug that prevented users from specifying all possible source types when they tried to add more probes to existing measurements.\n- Cover case where a user specified really long list of probes/measurements in the ProbeRequest/MeasurementRequest that was causing 'HTTP ERROR 414: Request-URI Too Long'. Additionally, now if API returns error raise an exception instead of stopping iteration.\n\n0.9.2 (released 2015-09-21)\n---------------------------\nChanges:\n~~~~~~~~\n- Small refactor of Stream class and manually enforce websockets in SocketIO client\n\n0.9.1 (released 2015-09-03)\n---------------------------\nBug Fixes:\n~~~~~~~~~~\n- Fix bug related to binding result atlas stream.\n\n0.9 (released 2015-09-01)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for fetching real time results using RIPE Atlas stream server.\n- this version and on will be available on PYPI.\n\n0.8 (released 2015-08-31)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for NTP measurements.\n\n0.7 (released 2015-06-03)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for fetching probes/measurements meta data using python generators.\n\n0.6 (released 2014-06-17)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for querying results based on start/end time, msm_id and probe id.\n\nChanges:\n~~~~~~~~\n- add http agent according to package version to all requests.\n\n0.5 (released 2014-05-22)\n-------------------------\nChanges:\n~~~~~~~~\n- change package structure to comply with the new structure of atlas packages\n- add continuous integration support\n\n - add tests\n - enable travis\n - enable code health checks\n\n- add required files for uploading to github\n\n0.4 (released 2014-03-31)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for stopping a measurement.\n\n0.3 (released 2014-02-25)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add simple support for HTTP GET queries.\n\n0.2 (released 2014-02-03)\n-------------------------\nNew features:\n~~~~~~~~~~~~~\n- add support for adding/removing probes API request.\n\nChanges:\n~~~~~~~~\n- use AtlasCreateRequest instead of AtlasRequest for creating a new measurement.\n\n0.1 (released 2014-01-21)\n-------------------------\n- Initial release.\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Python wrapper for RIPE Atlas API",
"version": "2.0.0",
"split_keywords": [
"ripe",
"ripe ncc",
"ripe atlas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "912f39ba8aec9b29206539030a712609bdfb85ff1cd680cb4511c3c535dfb9e2",
"md5": "97612cca5f669c899677e5095b7fbe58",
"sha256": "e18a29f8ce338f45935cb8745dca80320900f6d15a4220b718c2971d7374c158"
},
"downloads": -1,
"filename": "ripe.atlas.cousteau-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97612cca5f669c899677e5095b7fbe58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35731,
"upload_time": "2023-01-23T09:48:51",
"upload_time_iso_8601": "2023-01-23T09:48:51.339580Z",
"url": "https://files.pythonhosted.org/packages/91/2f/39ba8aec9b29206539030a712609bdfb85ff1cd680cb4511c3c535dfb9e2/ripe.atlas.cousteau-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-23 09:48:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "RIPE-NCC",
"github_project": "ripe-atlas-cousteau",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ripe.atlas.cousteau"
}
JSON
