RIPE Atlas Tools (Magellan)
===========================
|Documentation| |Build Status| |PYPI Version| |Python Versions| |Python Implementations| |Python Format| |Requirements|
The official command-line client for RIPE Atlas.
Full Documentation
------------------
Everything is up on `ReadTheDocs`_
Examples
--------
Configure API key for creating measurements::
$ ripe-atlas configure --set authorisation.create=MY_API_KEY
Ping an IP address from five probes::
$ ripe-atlas measure ping ping.ripe.net --probes 5
.. image:: screenshots/ripe-atlas-measure-ping.png
Search for connected probes in Germany, grouping by ASN::
$ ripe-atlas probe-search --country de --aggregate-by asn_v4 --limit 10
.. image:: screenshots/ripe-atlas-probe-search.png
Search for NTP measurement metadata and process the results with awk::
$ ripe-atlas measurement-search --type ntp --format tab --no-header --limit 5 \
| awk -Ft '{printf "#%s (%s)\n", $1, $3}'
.. image:: screenshots/ripe-atlas-measurement-search.png
Can I Contribute?
-----------------
Absolutely. Please read our `guide`_ on how to contribute.
Colophon
--------
This project was code-named by means of a `poll`_. In order to conform to the
RIPE Atlas theme, it had to be named for an explorer, and so the winning
suggestion was for Magellan, *"in memory of those times when RTT was ~3 years"*.
.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-tools/badge/?version=latest
:target: http://ripe-atlas-tools.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
.. _ReadTheDocs: https://ripe-atlas-tools.readthedocs.org/
.. _guide: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CONTRIBUTING.rst
.. _poll: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/13
.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools.png?branch=master
:target: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools
.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.tools.svg
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.tools.svg
.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.tools.svg
.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.tools.svg
.. |Requirements| image:: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements.svg?branch=master
:target: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements/?branch=master
:alt: Requirements Status
Release History
===============
3.1.1 (release 2024-04-10)
--------------------------
- Pin urllib3 to < 2 so that it works on LibreSSL Python
3.1.0 (release 2023-02-07)
--------------------------
- Improved probe-search and measurement-search, including "csv" and "tab" output
- --stream-timeout and --stream-limit added to measure command
- Use the latest stream API (cousteau update) and add --timeout to stream command
3.0.3 (release 2022-11-18)
--------------------------
- Fix issue where the measure command would continue to stream results after all probes have responded
3.0.2 (release 2022-05-23)
--------------------------
- Fix "measure spec" command which was broken due to cousteau issue
3.0.1 (release 2022-02-24)
--------------------------
- Updated cousteau dependency to the non-alpha release
3.0.0 (release 2022-02-23)
--------------------------
- API keys can now be passed in environment variables
- probe-search by --location now works, as long as the user specifies their own Google Geocoding API key
- Modernized tests and switched to GitHub actions
- The default renderer for ping measurements is now more consistent and more similar to other ping tools, including having a statistical summary at the end
- measure, report and stream commands now all use the same set of renderers
- "measure spec" command which takes a JSON blob to create measurements
- Allow measure --target to be specified as a positional arg (or --query-argument for DNS)
- Move to latest cousteau version (python-socketio)
- Various other fixes to code and documentation
- Official supported Python versions changed to 3.6, 3.7, 3.8, 3.9 and 3.10
2.3.0 (released 2018-11-23)
---------------------------
Features and changes
~~~~~~~~~~~~~~~~~~~~
- Add result date and time to traceroute, NTP and SSL renderers
- Add support for specifying measurement tags on measurement creation
- Add option (--go-web) to open measurement URL in browser
- Nicer presentation of 403 errors from the API
- Official supported Python versions changed to 2.7, 3.4, 3.5, 3.6 and 3.7
Bug Fixes
~~~~~~~~~
- Fix cousteau/sagan dependencies
2.2.3 (released 2017-01-17)
---------------------------
Bug Fixes
~~~~~~~~~
- Fix for distribution issues that prevented the command-line scripts from working
2.2.2 (released 2017-10-12)
---------------------------
Features and changes
~~~~~~~~~~~~~~~~~~~~
- Align various option defaults, minimums and maximums with API reality, including...
- ... allow the set of options necessary for "TCP ping" measurements https://labs.ripe.net/Members/wilhelm/measuring-your-web-server-reachability-with-tcp-ping
- Add compact DNS results renderer
- Fix some unicode output issues
2.1 (released 2016-04-21)
---------------------------
New Features
~~~~~~~~~~~~
- Add a simple NTP renderer
Changes
~~~~~~~
- Use new cousteau (1.4) & sagan(1.2) versions.
Bug Fixes
~~~~~~~~~
- Fix for some unicode problems when using colors
- Fix issue #177, with `gdbm` problem.
2.0.2 (released 2016-10-21)
---------------------------
New Features
~~~~~~~~~~~~
- Add aliases to measurements IDs
- Add --traceroute-show-asns to traceroute renderer
Bug Fixes
~~~~~~~~~
- Stream command was not passing the correct API key. After API became stricter this command started failing.
- Handle missing geometry for probes.
- Fix issues for AS-paths with only 1 probe
- Various fixes for tests
2.0.1 (released 2016-04-20)
---------------------------
Changes
~~~~~~~
- Corrected references in the docs to obsolete command names.
- Fixed broken 2.0.0 egg.
2.0.0 (released 2016-04-20)
---------------------------
Changes
~~~~~~~
- Renamed and merged some commands for clarity, preserving the old names as deprecated aliases.
- Improved help text and usage output.
- Support for bash auto-completion.
1.2.3 (released 2016-03-08)
---------------------------
Changes
~~~~~~~
- Usage of newest Cousteau/Sagan library.
- Support of API keys for fetching results on report command.
- Default radius for probes filtering is changed to 15.
- Several changes for supporting Windows.
1.2.2 (released 2016-01-13)
---------------------------
New Features
~~~~~~~~~~~~
- Cleaner and more consistent implementation of the renderer plugable
architecture.
- Usage of newest Cousteau library.
1.2.1 (released 2015-12-15)
---------------------------
Bug Fixes
~~~~~~~~~
- Restored some required template files.
1.2.0 (released 2015-12-15)
---------------------------
Output Changes
~~~~~~~~~~~~~~
- `#119`_: Support HTTP results.
- `#122`_: Allow packagers to set the user agent.
1.1.1 (released 2015-11-25)
---------------------------
Output Changes
~~~~~~~~~~~~~~
- `#103`_: Removed header from the ``report`` command.
Bug Fixes
~~~~~~~~~
- `#105`_: Measurement report and stream broken on Python3.4.
1.1.0 (released 2015-11-12)
---------------------------
New features
~~~~~~~~~~~~
- Support for the creation of NTP, SSLCert, and HTTP measurements.
- Additional argument in report command to filter results by probe ASN.
- Additional renderer that shows the different destination ASNs and some
additional stats about them.
Bug Fixes
~~~~~~~~~
- Various fixes.
Changes
~~~~~~~
- Better testing.
- Additional documentation.
1.0.0 (released 2015-11-02)
---------------------------
- Initial release.
.. _#103: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/103
.. _#105: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/105
.. _#119: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/119
.. _#122: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/122
Raw data
{
"_id": null,
"home_page": "https://github.com/RIPE-NCC/ripe-atlas-tools",
"name": "ripe.atlas.tools",
"maintainer": "The RIPE Atlas team",
"docs_url": null,
"requires_python": null,
"maintainer_email": "atlas@ripe.net",
"keywords": "RIPE, RIPE NCC, RIPE Atlas, Command Line",
"author": "The RIPE Atlas team",
"author_email": "atlas@ripe.net",
"download_url": "https://files.pythonhosted.org/packages/85/dd/eb26b239d4cf9a108cc1c7898368abcf9c327f92530845ab6c526e2b9ed4/ripe.atlas.tools-3.1.1.tar.gz",
"platform": null,
"description": "RIPE Atlas Tools (Magellan)\n===========================\n|Documentation| |Build Status| |PYPI Version| |Python Versions| |Python Implementations| |Python Format| |Requirements|\n\nThe official command-line client for RIPE Atlas.\n\n\nFull Documentation\n------------------\n\nEverything is up on `ReadTheDocs`_\n\nExamples\n--------\nConfigure API key for creating measurements::\n\n $ ripe-atlas configure --set authorisation.create=MY_API_KEY\n\nPing an IP address from five probes::\n\n $ ripe-atlas measure ping ping.ripe.net --probes 5\n\n.. image:: screenshots/ripe-atlas-measure-ping.png\n\nSearch for connected probes in Germany, grouping by ASN::\n\n $ ripe-atlas probe-search --country de --aggregate-by asn_v4 --limit 10\n\n.. image:: screenshots/ripe-atlas-probe-search.png\n\nSearch for NTP measurement metadata and process the results with awk::\n\n $ ripe-atlas measurement-search --type ntp --format tab --no-header --limit 5 \\\n | awk -Ft '{printf \"#%s (%s)\\n\", $1, $3}'\n\n.. image:: screenshots/ripe-atlas-measurement-search.png\n\n\n\nCan I Contribute?\n-----------------\n\nAbsolutely. Please read our `guide`_ on how to contribute.\n\n\nColophon\n--------\n\nThis project was code-named by means of a `poll`_. In order to conform to the\nRIPE Atlas theme, it had to be named for an explorer, and so the winning\nsuggestion was for Magellan, *\"in memory of those times when RTT was ~3 years\"*.\n\n.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-tools/badge/?version=latest\n :target: http://ripe-atlas-tools.readthedocs.org/en/latest/?badge=latest\n :alt: Documentation Status\n.. _ReadTheDocs: https://ripe-atlas-tools.readthedocs.org/\n.. _guide: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CONTRIBUTING.rst\n.. _poll: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/13\n.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools.png?branch=master\n :target: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools\n.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.tools.svg\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.tools.svg\n.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.tools.svg\n.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.tools.svg\n.. |Requirements| image:: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements.svg?branch=master\n :target: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements/?branch=master\n :alt: Requirements Status\n\n\n\nRelease History\n===============\n3.1.1 (release 2024-04-10)\n--------------------------\n- Pin urllib3 to < 2 so that it works on LibreSSL Python\n\n3.1.0 (release 2023-02-07)\n--------------------------\n- Improved probe-search and measurement-search, including \"csv\" and \"tab\" output\n- --stream-timeout and --stream-limit added to measure command\n- Use the latest stream API (cousteau update) and add --timeout to stream command\n\n3.0.3 (release 2022-11-18)\n--------------------------\n- Fix issue where the measure command would continue to stream results after all probes have responded\n\n3.0.2 (release 2022-05-23)\n--------------------------\n- Fix \"measure spec\" command which was broken due to cousteau issue\n\n3.0.1 (release 2022-02-24)\n--------------------------\n- Updated cousteau dependency to the non-alpha release\n\n3.0.0 (release 2022-02-23)\n--------------------------\n- API keys can now be passed in environment variables\n- probe-search by --location now works, as long as the user specifies their own Google Geocoding API key\n- Modernized tests and switched to GitHub actions\n- The default renderer for ping measurements is now more consistent and more similar to other ping tools, including having a statistical summary at the end\n- measure, report and stream commands now all use the same set of renderers\n- \"measure spec\" command which takes a JSON blob to create measurements\n- Allow measure --target to be specified as a positional arg (or --query-argument for DNS)\n- Move to latest cousteau version (python-socketio)\n- Various other fixes to code and documentation\n- Official supported Python versions changed to 3.6, 3.7, 3.8, 3.9 and 3.10\n\n\n2.3.0 (released 2018-11-23)\n---------------------------\n\nFeatures and changes\n~~~~~~~~~~~~~~~~~~~~\n- Add result date and time to traceroute, NTP and SSL renderers\n- Add support for specifying measurement tags on measurement creation\n- Add option (--go-web) to open measurement URL in browser\n- Nicer presentation of 403 errors from the API\n- Official supported Python versions changed to 2.7, 3.4, 3.5, 3.6 and 3.7\n\nBug Fixes\n~~~~~~~~~\n- Fix cousteau/sagan dependencies\n\n\n2.2.3 (released 2017-01-17)\n---------------------------\n\nBug Fixes\n~~~~~~~~~\n- Fix for distribution issues that prevented the command-line scripts from working\n\n2.2.2 (released 2017-10-12)\n---------------------------\n\nFeatures and changes\n~~~~~~~~~~~~~~~~~~~~\n- Align various option defaults, minimums and maximums with API reality, including...\n- ... allow the set of options necessary for \"TCP ping\" measurements https://labs.ripe.net/Members/wilhelm/measuring-your-web-server-reachability-with-tcp-ping \n- Add compact DNS results renderer\n- Fix some unicode output issues\n\n2.1 (released 2016-04-21)\n---------------------------\n\nNew Features\n~~~~~~~~~~~~\n- Add a simple NTP renderer\n\nChanges\n~~~~~~~\n- Use new cousteau (1.4) & sagan(1.2) versions.\n\nBug Fixes\n~~~~~~~~~\n- Fix for some unicode problems when using colors\n- Fix issue #177, with `gdbm` problem.\n\n2.0.2 (released 2016-10-21)\n---------------------------\n\nNew Features\n~~~~~~~~~~~~\n- Add aliases to measurements IDs\n- Add --traceroute-show-asns to traceroute renderer\n\nBug Fixes\n~~~~~~~~~\n- Stream command was not passing the correct API key. After API became stricter this command started failing.\n- Handle missing geometry for probes.\n- Fix issues for AS-paths with only 1 probe\n- Various fixes for tests\n\n2.0.1 (released 2016-04-20)\n---------------------------\n\nChanges\n~~~~~~~\n- Corrected references in the docs to obsolete command names.\n- Fixed broken 2.0.0 egg.\n\n\n2.0.0 (released 2016-04-20)\n---------------------------\n\nChanges\n~~~~~~~\n- Renamed and merged some commands for clarity, preserving the old names as deprecated aliases.\n- Improved help text and usage output.\n- Support for bash auto-completion.\n\n\n1.2.3 (released 2016-03-08)\n---------------------------\n\nChanges\n~~~~~~~\n- Usage of newest Cousteau/Sagan library.\n- Support of API keys for fetching results on report command.\n- Default radius for probes filtering is changed to 15.\n- Several changes for supporting Windows.\n\n\n1.2.2 (released 2016-01-13)\n---------------------------\n\nNew Features\n~~~~~~~~~~~~\n- Cleaner and more consistent implementation of the renderer plugable\n architecture.\n- Usage of newest Cousteau library.\n\n\n1.2.1 (released 2015-12-15)\n---------------------------\n\nBug Fixes\n~~~~~~~~~\n- Restored some required template files.\n\n\n1.2.0 (released 2015-12-15)\n---------------------------\n\nOutput Changes\n~~~~~~~~~~~~~~\n- `#119`_: Support HTTP results.\n- `#122`_: Allow packagers to set the user agent.\n\n\n1.1.1 (released 2015-11-25)\n---------------------------\n\nOutput Changes\n~~~~~~~~~~~~~~\n- `#103`_: Removed header from the ``report`` command.\n\nBug Fixes\n~~~~~~~~~\n- `#105`_: Measurement report and stream broken on Python3.4.\n\n1.1.0 (released 2015-11-12)\n---------------------------\n\nNew features\n~~~~~~~~~~~~\n- Support for the creation of NTP, SSLCert, and HTTP measurements.\n- Additional argument in report command to filter results by probe ASN.\n- Additional renderer that shows the different destination ASNs and some\n additional stats about them.\n\nBug Fixes\n~~~~~~~~~\n- Various fixes.\n\nChanges\n~~~~~~~\n- Better testing.\n- Additional documentation.\n\n1.0.0 (released 2015-11-02)\n---------------------------\n- Initial release.\n\n.. _#103: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/103\n.. _#105: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/105\n.. _#119: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/119\n.. _#122: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/122\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "The official command line client for RIPE Atlas",
"version": "3.1.1",
"project_urls": {
"Download": "https://github.com/RIPE-NCC/ripe-atlas-tools",
"Homepage": "https://github.com/RIPE-NCC/ripe-atlas-tools"
},
"split_keywords": [
"ripe",
" ripe ncc",
" ripe atlas",
" command line"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a461df17c1b3a7e7f150301e8d1c93fe718947108b5e217ffd2e1d4a26715c1",
"md5": "4bffe8a0214c99fafbf4084417e3097b",
"sha256": "c3628cab34f1d70338fa50710b7f368ddfca866d66596529c5ca783b4a2fda67"
},
"downloads": -1,
"filename": "ripe.atlas.tools-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bffe8a0214c99fafbf4084417e3097b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 121451,
"upload_time": "2024-04-10T12:11:35",
"upload_time_iso_8601": "2024-04-10T12:11:35.681547Z",
"url": "https://files.pythonhosted.org/packages/7a/46/1df17c1b3a7e7f150301e8d1c93fe718947108b5e217ffd2e1d4a26715c1/ripe.atlas.tools-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85ddeb26b239d4cf9a108cc1c7898368abcf9c327f92530845ab6c526e2b9ed4",
"md5": "5cb4579f1fc1faa85428395574a33450",
"sha256": "410b7698410142bf8c5eb1d6ff26f386662da5095d7aaf8883dc914a672e0b5c"
},
"downloads": -1,
"filename": "ripe.atlas.tools-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5cb4579f1fc1faa85428395574a33450",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 113044,
"upload_time": "2024-04-10T12:11:37",
"upload_time_iso_8601": "2024-04-10T12:11:37.779974Z",
"url": "https://files.pythonhosted.org/packages/85/dd/eb26b239d4cf9a108cc1c7898368abcf9c327f92530845ab6c526e2b9ed4/ripe.atlas.tools-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 12:11:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RIPE-NCC",
"github_project": "ripe-atlas-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ripe.atlas.tools"
}
JSON
