pax_global_header 0000666 0000000 0000000 00000000064 14370416630 0014516 g ustar 00root root 0000000 0000000 52 comment=0ca04abb61d85983b2ac1e1b2f20a934435e1ab5
ripe-atlas-tools-3.1.0/ 0000775 0000000 0000000 00000000000 14370416630 0014716 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/.github/ 0000775 0000000 0000000 00000000000 14370416630 0016256 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/.github/workflows/ 0000775 0000000 0000000 00000000000 14370416630 0020313 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/.github/workflows/python-package.yml 0000664 0000000 0000000 00000001525 14370416630 0023753 0 ustar 00root root 0000000 0000000 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: Python package
on:
push:
branches: [ master, 'release-*' ]
pull_request:
branches: [ $default-branch ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install tox
- name: tox
run: tox
ripe-atlas-tools-3.1.0/.gitignore 0000664 0000000 0000000 00000001327 14370416630 0016711 0 ustar 00root root 0000000 0000000 # Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*.swp
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# PyCharm
.idea/
ripe-atlas-tools-3.1.0/CHANGES.rst 0000664 0000000 0000000 00000012525 14370416630 0016525 0 ustar 00root root 0000000 0000000 Release History
===============
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
ripe-atlas-tools-3.1.0/CONTRIBUTING.rst 0000664 0000000 0000000 00000004723 14370416630 0017365 0 ustar 00root root 0000000 0000000 How To Contribute
=================
We would love to have contributions from everyone and no contribution is too
small. Please submit as many fixes for typos and grammar bloopers as you can!
To make participation in this project as pleasant as possible for everyone,
we adhere to the `Code of Conduct`_ by the Python Software Foundation.
The following steps will help you get started:
Fork, then clone the repo:
.. code:: bash
$ git clone git@github.com:your-username/ripe-atlas-tools.git
Make sure the tests pass beforehand:
.. code:: bash
$ tox
or
.. code:: bash
$ nosetests tests/
Make your changes. Include tests for your change. Make the tests pass:
.. code:: bash
$ tox
or
.. code:: bash
$ nosetests tests/
Push to your fork and `submit a pull request`_.
Here are a few guidelines that will increase the chances of a quick merge of
your pull request:
- *Always* try to add tests and docs for your code. If a feature is tested and
documented, it's easier for us to merge it.
- Follow `PEP 8`_.
- Write `good commit messages`_.
- If you change something that is noteworthy, don't forget to add an entry to
the `changes`_.
.. note::
- If you think you have a great contribution but aren’t sure whether it
adheres -- or even can adhere -- to the rules: **please submit a pull
request anyway**! In the best case, we can transform it into something
usable, in the worst case the pull request gets politely closed. There’s
absolutely nothing to fear.
- If you have a great idea but you don't know how or don't have the time to
implement it, please consider opening an issue and someone will pick it up
as soon as possible.
Thank you for considering a contribution to this project! If you have any
questions or concerns, feel free to reach out the RIPE Atlas team via the
`mailing list`_, `GitHub Issue Queue`_, or `messenger pigeon`_ -- if you must.
.. _submit a pull request: https://github.com/RIPE-NCC/ripe-atlas-tools/compare/
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _good commit messages: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
.. _Code of Conduct: https://www.python.org/psf/codeofconduct/
.. _changes: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CHANGES.rst
.. _mailing list: https://www.ripe.net/mailman/listinfo/ripe-atlas
.. _GitHub Issue Queue: https://github.com/RIPE-NCC/ripe-atlas-tools/issues
.. _messenger pigeon: https://tools.ietf.org/html/rfc1149
ripe-atlas-tools-3.1.0/LICENSE 0000664 0000000 0000000 00000104460 14370416630 0015730 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
. ripe-atlas-tools-3.1.0/MANIFEST.in 0000664 0000000 0000000 00000000343 14370416630 0016454 0 ustar 00root root 0000000 0000000 include LICENSE
include README.rst
include CHANGES.rst
include MANIFEST.in
include ripe/atlas/tools/user-agent
recursive-include ripe *.py
recursive-include ripe *.yaml
recursive-include ripe *.txt
recursive-include tests *.py
ripe-atlas-tools-3.1.0/PACKAGING.md 0000664 0000000 0000000 00000005510 14370416630 0016525 0 ustar 00root root 0000000 0000000 We're working with the community to get this project packaged for as many
platforms as possible. To that end, We've created this file to help organise
resources.
If you'd like to package the toolkit for your favourite distro, or if you've
already started, please add your name/GitHub below with a pull request so we
don't have people wasting time doubling up on work rather than collaborating.
## OpenBSD
* [Florian Obser](https://github.com/fobser)
### Status
During the Bucharest hackathon, Florian hacked out a package it's already
[in the ports tree](http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/net/py-ripe.atlas.tools/).
## FreeBSD
* [Max Stucchi](https://github.com/stucchimax)
### Status
Max has submitted the new ports and [they have been accepted](https://svnweb.freebsd.org/ports?view=revision&revision=403526).
## Gentoo
* [Daniel Quinn](https://github.com/danielquinn)
### Status
After a great deal of help from #gentoo-proxy-maint, Daniel's pull requests were accepted into the Gentoo portage tree. You can now install it with `emerge ripe-atlas-tools`.
## Debian
* Apollon Oikonomopoulos
### Status
Apollon has imported the project to [debian tree](https://tracker.debian.org/pkg/ripe-atlas-tools).
## Ubuntu
### Status
Apollon's work in debian has made it also to Ubuntu.
## Arch
* [Wouter de Vries](https://github.com/woutifier)
### Status
Wouter has added this project to [Arch's AUR repository](https://aur.archlinux.org/packages/ripe-atlas-tools).
## Fedora
* [Jan Včelák](https://github.com/vcelda)
### Status
In progress: https://github.com/fcelda/fedora-ripe-atlas-tools
Jan is currently building the binary packages in COPR (which will take some time as there is a lot of other packages in the queue):
https://copr.fedoraproject.org/coprs/jvcelak/ripe-atlas-tools/
## Voidlinux
* [jnbr](https://github.com/jnbr)
### Status
With a lot of help from the Voidlinux maintainers, it got merged into the [XBPS source packages collection](https://github.com/voidlinux/void-packages/srcpkgs/ripe-atlas-tools). You can install it with `xbps-install ripe-atlas-tools`.
## Windows
* [Chris Amin](https://github.com/chrisamin)
### Status
A highly experimental self-contained installer is available at https://github.com/chrisamin/ripe-atlas-tools-win32/. This installer doesn't require the presence of a system Python installation.
## Other Platforms
We've been talking with members of the community about expanding the package
support for Magellan, but so far no one has officially volunteered. The RIPE
Atlas team is happy to assist anyone interested in porting this toolkit to any
platform, but we're especially keen on at least getting into:
* Red Hat
* CentOS
If you'd like to try your hand, or would simply like to offer some advice, feel
free to add your name here or contact us directly via *atlas at ripe dot net*.
ripe-atlas-tools-3.1.0/README.rst 0000664 0000000 0000000 00000004742 14370416630 0016414 0 ustar 00root root 0000000 0000000 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
ripe-atlas-tools-3.1.0/dev-scripts/ 0000775 0000000 0000000 00000000000 14370416630 0017161 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/dev-scripts/compare-openapi-spec.py 0000664 0000000 0000000 00000011570 14370416630 0023546 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
"""
Compare the CLI measure command options with the fields, limits and defaults
from the API via a call to the OpenAPI (swagger) URL.
"""
from __future__ import print_function
import requests
from ripe.atlas.tools.commands.base import Command
openapi_url = "https://atlas.ripe.net/docs/api/v2/reference/api-docs/api/v2/measurements"
types = [
("ping", "Writeping measurement"),
("traceroute", "Writetraceroute measurement"),
("dns", "WriteDNS measurement"),
("sslcert", "SSL cert measurement"),
("http", "HTTP measurement"),
("ntp", "NTP measurement"),
]
# These are the expected differences from the OpenAPI spec.
# If somethign is defined here it means that an option deliberately has a
# different default, valid range or is not included in the CLI tools.
# e.g. if we want the tools to behave more like their common unix counterparts
# or it makes sense to express things differently on a command-line
common_differences = {
"is_oneoff": None, # implied by lack of --interval
"type": None, # set as the subcommand
"start_time": None, # deliberately unsupported
"stop_time": None, # deliberately unsupported
"is_public": None, # deliberately unsupported
"description": {
"default": "",
},
"interval": {
"default": None,
},
"resolve_on_probe": None, # Not sent explicitly to preserve behaviour
}
type_expected_differences = {
"ping": dict(common_differences, **{
"packet_interval": {
"default": 1000,
},
"size": {
"default": 48,
},
"skip_dns_check": None,
}),
"traceroute": dict(common_differences, **{
"max_hops": {
"default": 255,
},
"protocol": {
"default": "ICMP",
},
"skip_dns_check": None,
"paris": {
"default": 0,
},
"dont_fragment": {
"default": False,
},
"response_timeout": {
"default": None,
}
}),
"dns": dict(common_differences, **{
"protocol": {
"default": "UDP",
},
"query_class": {
"default": "IN",
},
"query_type": {
"default": "A",
},
"skip_dns_check": None,
"set_rd_bit": {
"default": True,
},
"use_probe_resolver": None, # Implied by missing target
"include_abuf": None,
"include_qbuf": None,
"prepend_probe_id": None,
"use_macros": None,
}),
"sslcert": common_differences.copy(),
"http": dict(common_differences, **{
"extended_timing": None, # "timing_verbosity"
"more_extended_timing": None, # "timing_verbosity"
"max_bytes_read": {
"alias": "body_bytes",
},
"path": {
"default": "/",
}
}),
"ntp": common_differences.copy(),
}
def compare_type(cmd_name, api_model, expected_differences):
print(cmd_name)
cmd = Command.load_command_class("measure")(["measure", cmd_name]).create()
cmd.add_arguments()
args = {}
for arg in cmd.parser._actions:
args[arg.dest] = arg
seen_diffs = False
for field_name, model_field in sorted(api_model["properties"].items()):
if field_name in expected_differences and expected_differences[field_name] is None:
continue
if model_field["readOnly"]:
continue
explicit_values = expected_differences.get(field_name, {})
opt_name = explicit_values.get("alias", field_name)
if opt_name in args:
cmd_field = args.get(opt_name)
expected_default = explicit_values.get("default", model_field.get("defaultValue"))
if cmd_field.default != expected_default:
print("\t", field_name, "DEFAULT", repr(cmd_field.default), repr(expected_default))
seen_diffs |= True
expected_min = explicit_values.get("minimum", model_field.get("minimum"))
cmd_min = getattr(cmd_field.type, "minimum", None)
if cmd_min != expected_min:
print("\t", field_name, "MINIMUM", cmd_min, expected_min)
seen_diffs |= True
expected_max = explicit_values.get("maximum", model_field.get("maximum"))
cmd_max = getattr(cmd_field.type, "maximum", None)
if cmd_max != expected_max:
print("\t", field_name, "MAXIMUM", cmd_max, expected_max)
seen_diffs |= True
else:
print("\t", field_name, "\t", "MISSING")
seen_diffs |= True
if not seen_diffs:
print("\t", "OK")
if __name__ == "__main__":
api_spec = requests.get(openapi_url).json()
for cmd_name, api_name in types:
compare_type(
cmd_name,
api_spec["models"][api_name],
type_expected_differences[cmd_name]
)
ripe-atlas-tools-3.1.0/docs/ 0000775 0000000 0000000 00000000000 14370416630 0015646 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/docs/Makefile 0000664 0000000 0000000 00000015252 14370416630 0017313 0 ustar 00root root 0000000 0000000 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RIPEAtlasToolsMagellan.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RIPEAtlasToolsMagellan.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/RIPEAtlasToolsMagellan"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RIPEAtlasToolsMagellan"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
ripe-atlas-tools-3.1.0/docs/_static/ 0000775 0000000 0000000 00000000000 14370416630 0017274 5 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/docs/_static/.keep 0000664 0000000 0000000 00000000000 14370416630 0020207 0 ustar 00root root 0000000 0000000 ripe-atlas-tools-3.1.0/docs/_static/custom.css 0000664 0000000 0000000 00000000542 14370416630 0021321 0 ustar 00root root 0000000 0000000 /* override table width restrictions */
@media screen and (min-width: 767px) {
.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from
overriding this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}
.wy-table-responsive {
overflow: visible !important;
}
}
ripe-atlas-tools-3.1.0/docs/changelog.rst 0000664 0000000 0000000 00000000034 14370416630 0020324 0 ustar 00root root 0000000 0000000 .. include:: ../CHANGES.rst
ripe-atlas-tools-3.1.0/docs/conf.py 0000664 0000000 0000000 00000026222 14370416630 0017151 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
#
# RIPE Atlas Tools (Magellan) documentation build configuration file, created by
# sphinx-quickstart on Mon Oct 26 18:36:52 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
__version__ = None
exec(open("../ripe/atlas/tools/version.py").read())
# Believe it or not, this is the officially sanctioned way to add custom CSS.
def setup(app):
app.add_css_file("custom.css")
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'RIPE Atlas Tools (Magellan)'
copyright = u'2015, The RIPE Atlas Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
#
# If the build process ever explodes here, it's because you've set the version
# number in ripe.atlas.tools.version to a string in a format other than x.y.z
#
# The short X.Y version.
version = ".".join(__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags.
release = ".".join(__version__.split(".")[:3])
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'RIPEAtlasToolsMagellandoc'
#
# Attempt to use the ReadTheDocs theme. If it's not installed, fallback to
# the default.
#
try:
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except ImportError:
pass
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'RIPEAtlasToolsMagellan.tex', u'RIPE Atlas Tools (Magellan) Documentation',
u'The RIPE Atlas Team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'ripeatlastoolsmagellan', u'RIPE Atlas Tools (Magellan) Documentation',
[u'The RIPE Atlas Team'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'RIPEAtlasToolsMagellan', u'RIPE Atlas Tools (Magellan) Documentation',
u'The RIPE Atlas Team', 'RIPEAtlasToolsMagellan', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'RIPE Atlas Tools (Magellan)'
epub_author = u'The RIPE Atlas Team'
epub_publisher = u'The RIPE Atlas Team'
epub_copyright = u'2015, The RIPE Atlas Team'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'RIPE Atlas Tools (Magellan)'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
ripe-atlas-tools-3.1.0/docs/contributing.rst 0000664 0000000 0000000 00000000041 14370416630 0021102 0 ustar 00root root 0000000 0000000 .. include:: ../CONTRIBUTING.rst
ripe-atlas-tools-3.1.0/docs/index.rst 0000664 0000000 0000000 00000001224 14370416630 0017506 0 ustar 00root root 0000000 0000000 RIPE Atlas Tools (Magellan)
===========================
The official command-line client for RIPE Atlas.
.. _index-why-this-exists:
Why This Exists
===============
`RIPE Atlas`_ is a powerful Internet measurements platform that until recently
was only accessible via the website and the RESTful API. The reality however is
that a great many people using RIPE Atlas are most comfortable on the
command-line, so this project is an attempt to fill that gap.
.. _RIPE Atlas: https://atlas.ripe.net
Contents
========
.. toctree::
:maxdepth: 2
quickstart
installation
use
plugins
contributing
packaging
troubleshooting
changelog
ripe-atlas-tools-3.1.0/docs/installation.rst 0000664 0000000 0000000 00000016075 14370416630 0021112 0 ustar 00root root 0000000 0000000 .. _requirements-and-installation:
Requirements & Installation
***************************
This is a Linux-based tool, though it should work just fine in a BSD variant.
Windows is experimentally supported. In terms of the actual installation,
only Python's package manager (``pip``) is currently supported, and the
installation process may require some system packages to be installed in order
for everything to work.
.. _requirements-and-installation-system-requirements:
System Requirements
===================
Some of the dependencies need to be compiled, so you'll need a compiler on your
system, as well as the development libraries for Python. In the Linux world,
this typically means a few packages need to be installed from your standard
package manager, but in true Linux fashion, each distribution does things
slightly differently.
The most important thing to know is that you need Python 2.7 or 3. Python 2.6
will never be supported because it's old, ugly, and needs to die.
.. _requirements-and-installation-distribution-specific-requirements:
Distribution Specific Requirements
----------------------------------
.. note::
If you're running OpenBSD, you can skip this whole section. You can even
skip the next one too. Just skip down to
:ref:`Installation:OpenBSD ` and follow the
instructions. Everything else is taken care of for you.
.. _requirements-and-installation-distribution-specific-requirements-debian:
Debian/Ubuntu
.............
The following has been tested on Debian Jessie.
Debian-based distributions require three system packages to be installed first:
.. code:: bash
sudo apt-get install python-dev libffi-dev libssl-dev
You'll also need either ``virtualenv`` (recommended), or if you're not
comfortable with that, at the very least, you'll need ``pip``:
.. code:: bash
sudo apt-get install python-virtualenv python-pip
.. _requirements-and-installation-distribution-specific-requirements-centos:
CentOS
......
This following has been tested on CentOS 7.
Since we require Python's ``pip``, we first need to install the ``epel-release``
repository:
.. code:: bash
sudo yum install epel-release
You'll also need the following system libraries:
.. code:: bash
sudo yum install gcc libffi-devel openssl-devel
Once that's finished, you'll need access to ``virtualenv`` (recommended), or if
you're not comfortable with that, at the very least, you'll need ``pip``:
.. code:: bash
sudo yum install python-virtualenv python-pip
.. _requirements-and-installation-distribution-specific-requirements-gentoo:
Gentoo
......
If you're a Gentoo user, you never have to worry about development libraries,
but if you intend to use the bleeding-edge version of this package (and what
self-respecting Gentoo user wouldn't?) then you'll probably want to make sure
that git is built with curl support:
.. code:: bash
sudo USE="curl" emerge git
If you're not going bleeding edge, or if you're just going to use SSH to get the
code from GitHub, then Gentoo will have everything ready for you.
.. _requirements-and-installation-distribution-specific-requirements-apple:
Apple OSX
.........
These instructions expect that you've got Python's ``pip`` installed, so if you
have no idea what that is, or simply don't have it yet, you should be able to
install pip with one easy command:
.. code:: bash
sudo easy_install pip
Outside of that, a few of the Python dependencies require that you have a
compiler on your system. For this, you need only get a free copy of `Xcode`_
from the app store, and from there you should be good to go.
.. _Xcode: https://itunes.apple.com/us/app/xcode/id497799835
.. _installation-python-requirements:
Python Requirements
===================
Importantly, Magellan requires Python 2.7 or higher. For most desktop users,
this shouldn't be a problem, but for some older servers like CentOS 6 and lower,
this may cause some pain. Thankfully, for most such systems, there are usually
work-arounds that allow you to install a more modern version of Python in
parallel.
Magellan depends on two other RIPE Atlas libraries, Cousteau and Sagan, which in
turn depend on a reasonable number of Python libraries. Thankfully, Python's
package manager, ``pip`` should handle all of these for you:
* ripe.atlas.cousteau
* ripe.atlas.sagan
* tzlocal
* pyyaml
.. _installation:
Installation
============
.. _installation-from-openbsd:
OpenBSD
-------
OpenBSD was the first platform to have a port for Magellan, so installation is
easy:
.. code:: bash
sudo pkg_add ripe.atlas.tools
.. _installation-from-freebsd:
FreeBSD
-------
FreeBSD has a port ready for you:
.. code:: bash
cd /usr/ports/net/py-ripe.atlas.tools
make install
.. _installation-from-gentoo:
Gentoo
------
There's an ebuild for Magellan in Portage, so installation is as any other
package:
.. code:: bash
sudo emerge ripe-atlas-tools
.. _installation-from-pypi:
From PyPi
---------
Python's ``pip`` program can be used to install packages globally (not a good
idea since it conflicts with your system package manager) or on a per-user
basis. Typically, this is done with `virtualenv`_, but if you don't want to use
that, you can always pass ``--user`` to the ``pip`` program and it'll install a
user-based copy in ``${HOME}/.local/``.
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. code:: bash
# From within a virtualenv
pip install ripe.atlas.tools
# In your user's local environment
pip install --user ripe.atlas.tools
Or if you want to live on the edge and perhaps try submitting a pull request of
your own:
One day, we want this process to be as easy as installing any other command-line
program, that is, with ``apt``, ``dfn``, or ``emerge``, but until that day,
Python's standard package manager, ``pip`` does the job nicely.
.. _installation-from-github:
From GitHub
-----------
If you're feeling a little more daring and want to go bleeding-edge and use
our ``master`` branch on GitHub, you can have pip install right from there:
.. code:: bash
pip install git+https://github.com/RIPE-NCC/ripe-atlas-tools.git
If you think you'd like to contribute back to the project, we recommend the use
of pip's ``-e`` flag, which will place the Magellan code in a directory where
you can edit it, and see the results without having to go through a new install
procedure every time. Simply clone the repo on GitHub and install it like so:
.. code:: bash
pip install -e git+https://github.com/your-username/ripe-atlas-tools.git
.. _installation-from-tarball:
From a Tarball
--------------
If for some reason you want to just download the source and install it manually,
you can always do that too. Simply un-tar the file and run the following in the
same directory as ``setup.py``:
.. code:: bash
python setup.py install
Using Docker
--------------
You can find an unofficial Alpine-based docker image on Dockerhub `here `__, or simply build your own image based on the Dockerfile available `here `__.
ripe-atlas-tools-3.1.0/docs/packaging.rst 0000664 0000000 0000000 00000002635 14370416630 0020332 0 ustar 00root root 0000000 0000000 Packaging
=========
For those interested in packaging RIPE Atlas Tools for their favourite distro,
this section is for you.
Currently Supported
-------------------
* OpenBSD
* FreeBSD
* Gentoo
* Debian
* Ubuntu
In Progress
-----------
* Fedora: Jan Včelák is currently building the binary packages in `COPR`_ (which will take some time as there is a lot of other packages in the queue)
.. _`COPR`: https://copr.fedoraproject.org/coprs/jvcelak/ripe-atlas-tools/
Additional Distributions
------------------------
Is your distribution not listed? If you'd like to build a package for another
distro or even if you're just someone who knows someone who can help us package
and distribute this, please get in touch.
Further Information
-------------------
User Agent
~~~~~~~~~~
When packaging, it's good practise to manually set the user agent used within
the toolkit so that we can get a rough idea of which distros are using this
software. This is easily done by writing an arbitrary string to
``/ripe/atlas/tools/user-agent``. Something like this is recommended:::
RIPE Atlas Tools [FreeBSD 10.2] 1.2
The only limitations to this file are that it should:
* Only have one line in it (all other will be ignored)
* That line should have a maximum of 128 characters in it
If no ``user-agent`` file is included then a platform-specific string will be
automatically generated based on Python's ``platform`` module.
ripe-atlas-tools-3.1.0/docs/plugins.rst 0000664 0000000 0000000 00000016466 14370416630 0020076 0 ustar 00root root 0000000 0000000 .. _plugins:
How to Create Your Own Plugins
==============================
We built this toolkit for the community, and we knew going in that we couldn't
possibly build every feature that every user could want, so we built this
thing to be pluggable. You can write your own renderer(s) and use them
seamlessly within your own environment, and if you think that others might
benefit from your work, you can share your renderer as easy as posting a file
online.
Ready?
So you have an idea now. You want to create a renderer called "awesomerenderer"
and you want it to do some fancy things with traceroute measurement results.
What do you have to do?
.. _plugins-create:
Create Your Renderer File
-------------------------
As we've already covered, Magellan will look for renderers in very specific
places, so you need to put your file(s) there. Additionally however, you have
to make sure that you conform to Python norms, or stuff just won't work. Here's
the basic commands to get you started:
.. code:: bash
$ mkdir -p ${HOME}/.config/ripe-atlas-tools/renderers
$ touch ${HOME}/.config/ripe-atlas-tools/renderers/__init__.py
$ touch ${HOME}/.config/ripe-atlas-tools/renderers/my_renderer.py
The ``mkdir`` step there will create the renderers directory (if it doesn't
exist already), and the ``touch`` commands will create the mandatory init file
(for Python) and your renderer. Note that you can use whatever name you like
for your renderer, so long as it consists only of letters, numbers, and the
underscore and that it starts with a letter. Also, to be compliant with the
rest of the project, it should be entirely lowercase. For our purposes though,
``my_renderer.py`` will suffice.
.. _plugins-try-to-run:
(Try to) Run It!
----------------
If you run this right now:
.. code:: bash
$ ripe-atlas report --help
You should see ``my_renderer`` int he list of options for ``--renderer``.
Pretty cool eh? However, if you try to run that, this'll happen:
.. code:: bash
$ ripe-atlas report 1000192 --renderer my_renderer
The renderer you selected, "my_renderer" could not be found.
Which kind of makes sense really. You've created a file called ``my_renderer``,
but it's totally empty. Magellan found the file alright, but when it tried to
import ``Renderer`` from it, everything exploded.
.. _plugins-write:
Actually Write a Renderer
-------------------------
So now you know that we can see your renderer file, but you need to know what
kind of code to put in there. Don't worry, we've got you covered:
.. _plugins-write-anatomy:
Anatomy of a Renderer
~~~~~~~~~~~~~~~~~~~~~
A "renderer" is simply a file located in a special place that contains some
Python code defining a class called ``Renderer`` that subclasses
``ripe.atlas.tools.renderers.base.BaseRenderer``.
Your class need only define one method: ``on_result()``, which is called every
time a new result comes down the pipe. Let's look at a really simple example:
.. code:: python
from ripe.atlas.tools.renderers.base import Renderer as BaseRenderer
class Renderer(BaseRenderer):
# This renderer is capable of handling ping results only.
RENDERS = [BaseRenderer.TYPE_PING]
def on_result(self, result):
"""
on_result() only gets one argument, a result object, which is
actually an instance of a RIPE Atlas result parsed with Sagan:
https://ripe-atlas-sagan.readthedocs.org/
"""
return "Packets received: {}".format(result.packets_received)
As you can see, this renderer isn't very useful, but we're providing it here to
give you a rough idea of what you get to play with when defining your own
renderer.
In the case of our PingPacketRenderer, we're doing the simplest of tasks: we're
returning the number of packets in each result. The job of ``on_result()`` is
to take a Sagan result object as input and return a string. **It should not
print anything to standard out**, rather it should simply return a string that
will get printed to standard out by the surrounding framework.
.. _plugins-write-anatomy-additional:
Additional Options
::::::::::::::::::
It's likely that you will only ever need to work with ``on_result()``, but in
the event that you'd like to get more complicated, there are options:
``header()``, ``additional()``, and ``footer()``. Note however that these other
methods are currently only available to the ``report`` command. Streaming only
makes use of ``on_result()``.
.. _plugins-write-anatomy-additional-header:
header()
........
The value returned from this method is printed to standard out before any
results are captured. By default it returns an empty string.
.. _plugins-write-anatomy-additional-additional:
additional()
............
Typically used for summary logic, this is executed after the last result is
rendered. A common pattern is to override ``__init__()`` to set some collector
properties, update them via ``on_result()``, and then print out said properties
in a summary via this method. For an example, let's update our ``Renderer``
class:
.. code:: python
from ripe.atlas.tools.renderers.base import Renderer as BaseRenderer
class Renderer(BaseRenderer):
RENDERS = [BaseRenderer.TYPE_PING]
def __init__(self, *args, **kwargs):
self.packet_total = 0
BaseRenderer.__init__(self, *args, **kwargs)
def on_result(self, result):
self.packet_total += result.packets_received
return "Packets received: {}\n".format(result.packets_received)
def additional(self, results):
return "\nTotal packets received: {}\n".format(self.packet_total)
Note that the passed-in value of ``results`` is the list of Sagan Result objects
that were previously looped over for on_result(). You can do some interesting
things with that.
.. _plugins-write-anatomy-additional-footer:
footer()
........
Much the same as ``header()``, this should return a string, but unlike
``header()``, the output of this method is rendered after everything else.
.. _plugins-run:
Run It!
-------
Now that you've written your renderer and the file is stored where it's supposed
to be, it should be ready to go:
.. code:: bash
$ ripe-atlas report --help
You should see ``my_renderer`` in the list of options for ``--renderer`` just as
before, but now when you actually try to execute it...
.. code:: bash
$ ripe-atlas report 1000192 --renderer my_renderer
Packets received: 3
Packets received: 3
Packets received: 3
Packets received: 3
Packets received: 3
Packets received: 3
Total packets received: 18
It's not very interesting, but it's a start!
.. _plugins-contributing:
Contributing
------------
We love it when people write stuff that talks to our stuff. If you think your
stuff is useful, it'd be awesome if you could do any of these:
* Post to the [ripe-atlas mailing list](https://www.ripe.net/mailman/listinfo/ripe-atlas)
about it. You can also solicit feedback from the RIPE Atlas developers or the
wider community on this list.
* Write a blog post about your plugin, what makes it useful, etc.
* Tweet about it. Feel free to mention [@RIPE_Atlas](https://twitter.com/ripe_atlas)
and we might even retweet it.
* Create a [pull request](https://github.com/RIPE-NCC/ripe-atlas-tools/pulls)
for this project to get your plugin added to core.
ripe-atlas-tools-3.1.0/docs/quickstart.rst 0000664 0000000 0000000 00000002760 14370416630 0020577 0 ustar 00root root 0000000 0000000 Quickstart
==========
This is a very fast break down of everything you need to start using Ripe Atlas
on the command line. Viewing public data is quick & easy, while creation is a
little more complicated, since you need to setup your authorisation key.
Viewing Public Data
-------------------
1. :ref:`Install ` the toolkit.
2. View help with: ``ripe-atlas --help``
3. View a basic report for a public measurement: ``ripe-atlas report ``
4. View the live stream for a measurement: ``ripe-atlas stream ``
5. Get a list of probes in ASN 3333: ``ripe-atlas probe-search --asn 3333``
6. Get a list of measurements with the word "wikipedia" in them: ``ripe-atlas measurement-search --search wikipedia``
Creating a Measurement
----------------------
1. Log into `RIPE Atlas`_. If you don't have an
account, you can create one there for free.
2. Visit the `API Keys`_ page and create a new key
with the permission ``Create a new user defined measurement``
3. Install the toolkit as below.
4. Configure the toolkit to use your key with ``ripe-atlas configure --set authorisation.create=MY_API_KEY``
5. View the help for measurement creation with ``ripe-atlas measure --help``
6. Create a measurement with ``ripe-atlas measure ping --target example.com``
.. _`RIPE Atlas`: https://atlas.ripe.net/
.. _`API Keys`: https://atlas.ripe.net/keys/
Advanced Use
------------
Refer to the :ref:`complete usage documentation