prsw


Nameprsw JSON
Version 0.3.1 PyPI version JSON
download
home_page
SummaryPRSW, the Python RIPE Stat Wrapper, is a python package that simplifies access to the RIPE Stat public data API.
upload_time2023-01-13 16:48:13
maintainer
docs_urlNone
authorJonathan P. Voss
requires_python~=3.7
licenseSimplified BSD License
keywords ripe ripestat api wrapper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            PRSW: Python RIPE Stat Wrapper
==============================

.. image:: https://img.shields.io/pypi/v/prsw.svg
    :alt: Latest Version
    :target: https://pypi.python.org/pypi/prsw

.. image:: https://img.shields.io/pypi/pyversions/prsw
    :alt: Supported Python Versions
    :target: https://pypi.python.org/pypi/prsw

.. image:: https://github.com/jvoss/prsw/actions/workflows/tests.yml/badge.svg
  :alt: GitHub Actions Tests
  :target: https://github.com/jvoss/prsw/actions/workflows/tests.yml

.. image:: https://coveralls.io/repos/github/jvoss/prsw/badge.svg?branch=master
  :alt: Coveralls
  :target: https://coveralls.io/github/jvoss/prsw?branch=master

.. image:: https://readthedocs.org/projects/prsw/badge/?version=latest
  :target: https://prsw.readthedocs.io/en/latest/?badge=latest
  :alt: Documentation Status

PRSW, the RIPE Stat Wrapper, is a Python package that allows for simple access to 
the `RIPEstat Data API <https://stat.ripe.net/docs/data_api>`_. 

Installation
------------

PRSW is supported on Python 3.7+ and can be installed via 
`pip <https://pypi.python.org/pypi/pip>`_.

.. code-block:: bash

  pip install prsw

To install the latest development version run the following instead:

.. code-block:: bash

  pip install --upgrade https://github.com/jvoss/prsw/archive/master.zip

Quickstart
----------

RIPEstat can be instantiated with a few options. For details see the
documentation at `<https://prsw.readthedocs.io>`_.

To instantiate a basic instance of RIPEstat:

.. code-block:: python

  import prsw

  ripe = prsw.RIPEstat()

With the `ripe` instance you can interact with the RIPEstat API:

.. code-block:: python

  # Find all announced prefixes for a Autonomous System
  prefixes = ripe.announced_prefixes(3333)

  # Interact with the looking glass
  for collector in ripe.looking_glass('140.78.0.0/16'):
    print(collector.location)

    for peer in collector.peers:
        print(
            peer.asn_origin,
            peer.as_path,
            peer.community,
            peer.last_update,
            peer.prefix,
            peer.peer,
            peer.origin,
            peer.next_hop,
            peer.latest_time
        )

  # Check RPKI validation status
  print(ripe.rpki_validation_status(3333, '193.0.0.0/21').status)

Please see the `documentation <https://prsw.readthedocs.io/>`_ for more options.

Contributing
------------

Contributions are encouraged. Please see `CONTRIBUTING <CONTRIBUTING.rst>`_ for details.

Acknowledgements
----------------

Inspiration for several elements of this project came from 
`PRAW <https://github.com/praw-dev/praw>`_, the Python Reddit API Wrapper.

License
-------

PRSW is licened under the `Simplified BSD License <LICENSE.txt>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "prsw",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "~=3.7",
    "maintainer_email": "",
    "keywords": "RIPE RIPEStat api wrapper",
    "author": "Jonathan P. Voss",
    "author_email": "jvoss@onvox.net",
    "download_url": "https://files.pythonhosted.org/packages/bd/28/f95a94daad31f449f3ca455fe2eefe59a2e7e323f1109fdb7b4a62a91f88/prsw-0.3.1.tar.gz",
    "platform": null,
    "description": "PRSW: Python RIPE Stat Wrapper\n==============================\n\n.. image:: https://img.shields.io/pypi/v/prsw.svg\n    :alt: Latest Version\n    :target: https://pypi.python.org/pypi/prsw\n\n.. image:: https://img.shields.io/pypi/pyversions/prsw\n    :alt: Supported Python Versions\n    :target: https://pypi.python.org/pypi/prsw\n\n.. image:: https://github.com/jvoss/prsw/actions/workflows/tests.yml/badge.svg\n  :alt: GitHub Actions Tests\n  :target: https://github.com/jvoss/prsw/actions/workflows/tests.yml\n\n.. image:: https://coveralls.io/repos/github/jvoss/prsw/badge.svg?branch=master\n  :alt: Coveralls\n  :target: https://coveralls.io/github/jvoss/prsw?branch=master\n\n.. image:: https://readthedocs.org/projects/prsw/badge/?version=latest\n  :target: https://prsw.readthedocs.io/en/latest/?badge=latest\n  :alt: Documentation Status\n\nPRSW, the RIPE Stat Wrapper, is a Python package that allows for simple access to \nthe `RIPEstat Data API <https://stat.ripe.net/docs/data_api>`_. \n\nInstallation\n------------\n\nPRSW is supported on Python 3.7+ and can be installed via \n`pip <https://pypi.python.org/pypi/pip>`_.\n\n.. code-block:: bash\n\n  pip install prsw\n\nTo install the latest development version run the following instead:\n\n.. code-block:: bash\n\n  pip install --upgrade https://github.com/jvoss/prsw/archive/master.zip\n\nQuickstart\n----------\n\nRIPEstat can be instantiated with a few options. For details see the\ndocumentation at `<https://prsw.readthedocs.io>`_.\n\nTo instantiate a basic instance of RIPEstat:\n\n.. code-block:: python\n\n  import prsw\n\n  ripe = prsw.RIPEstat()\n\nWith the `ripe` instance you can interact with the RIPEstat API:\n\n.. code-block:: python\n\n  # Find all announced prefixes for a Autonomous System\n  prefixes = ripe.announced_prefixes(3333)\n\n  # Interact with the looking glass\n  for collector in ripe.looking_glass('140.78.0.0/16'):\n    print(collector.location)\n\n    for peer in collector.peers:\n        print(\n            peer.asn_origin,\n            peer.as_path,\n            peer.community,\n            peer.last_update,\n            peer.prefix,\n            peer.peer,\n            peer.origin,\n            peer.next_hop,\n            peer.latest_time\n        )\n\n  # Check RPKI validation status\n  print(ripe.rpki_validation_status(3333, '193.0.0.0/21').status)\n\nPlease see the `documentation <https://prsw.readthedocs.io/>`_ for more options.\n\nContributing\n------------\n\nContributions are encouraged. Please see `CONTRIBUTING <CONTRIBUTING.rst>`_ for details.\n\nAcknowledgements\n----------------\n\nInspiration for several elements of this project came from \n`PRAW <https://github.com/praw-dev/praw>`_, the Python Reddit API Wrapper.\n\nLicense\n-------\n\nPRSW is licened under the `Simplified BSD License <LICENSE.txt>`_.\n",
    "bugtrack_url": null,
    "license": "Simplified BSD License",
    "summary": "PRSW, the Python RIPE Stat Wrapper, is a python package that simplifies access to the RIPE Stat public data API.",
    "version": "0.3.1",
    "split_keywords": [
        "ripe",
        "ripestat",
        "api",
        "wrapper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e3b69b8483cee534aee6ee8a9e63233f5a6e977fea13af189b4f3435e0cdd90",
                "md5": "6ad6d91a33d8c2f11761987c25fec0a6",
                "sha256": "ad200c333403f7f617be92acf100168d728b2c41fdc5a59ff22b3288c43342db"
            },
            "downloads": -1,
            "filename": "prsw-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6ad6d91a33d8c2f11761987c25fec0a6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.7",
            "size": 24752,
            "upload_time": "2023-01-13T16:48:12",
            "upload_time_iso_8601": "2023-01-13T16:48:12.715261Z",
            "url": "https://files.pythonhosted.org/packages/3e/3b/69b8483cee534aee6ee8a9e63233f5a6e977fea13af189b4f3435e0cdd90/prsw-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd28f95a94daad31f449f3ca455fe2eefe59a2e7e323f1109fdb7b4a62a91f88",
                "md5": "8411c1808fc4e72900e7e58a0ae379d6",
                "sha256": "7065bb2875f1d8a9fb602337096d65e8a25aeaca553d6c0cc0c5f3eaffcace2b"
            },
            "downloads": -1,
            "filename": "prsw-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8411c1808fc4e72900e7e58a0ae379d6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 19077,
            "upload_time": "2023-01-13T16:48:13",
            "upload_time_iso_8601": "2023-01-13T16:48:13.793515Z",
            "url": "https://files.pythonhosted.org/packages/bd/28/f95a94daad31f449f3ca455fe2eefe59a2e7e323f1109fdb7b4a62a91f88/prsw-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-13 16:48:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "prsw"
}
        
Elapsed time: 0.02611s