{ "info": { "author": "Maxime Mouchet", "author_email": "max@maxmouchet.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# atlas_df: a dataframe-oriented interface to RIPE Atlas\n\n[![Python Version](https://img.shields.io/badge/python-3-blue.svg?style=flat)](#)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/maxmouchet/atlas_df/blob/master/LICENSE)\n[![Build Status](https://travis-ci.org/maxmouchet/atlas_df.svg?branch=master)](https://travis-ci.org/maxmouchet/atlas_df)\n[![Documentation Status](https://readthedocs.org/projects/atlas_df/badge/?version=latest)](https://atlas-df.readthedocs.io/en/latest/)\n[![Coverage Status](https://coveralls.io/repos/github/maxmouchet/atlas_df/badge.svg?branch=master)](https://coveralls.io/github/maxmouchet/atlas_df?branch=master)\n\n[![Example Map](https://github.com/maxmouchet/atlas_df/blob/master/examples/1001_map.png)](#)\n\natlas_df is an interface to the RIPE Atlas API built on top of the official client ([ripe-atlas-cousteau](https://github.com/RIPE-NCC/ripe-atlas-cousteau)). It converts Atlas resources to [pandas](https://github.com/pandas-dev/pandas) and [geopandas](https://github.com/geopandas/geopandas) DataFrames/Series. This makes the use of the Python scientific ecosystem (matplotlib, seaborn, numpy, scikit-learn, ...) with Atlas data very easy.\n\n**Features:**\n- Conversion of RIPE Atlas resources to `DataFrame` and `Series` objects.\n- [Caching](#cache) of API requests.\n- geo plot/queries ...\nTODO: logging, computation of geo distance between anchors/probes, ...\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Development](#development)\n- [Maintainers](#maintainers)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Install\n\natlas_df is a Python 3 library, depending on your setup, you may want to use `pip` or `pip3`.\n\n```bash\npip install atlas_df\n```\n\n## Usage\n\nA comprehensive (TODO) documentation is on [Read the Docs](https://atlas-df.readthedocs.io/en/latest/).\n\n```python\nfrom atlas_df.dataframes import AnchorDataFrame\n\nanchors = AnchorDataFrame.from_api()\nmeasurements = anchors.loc[1029].fetch_mesh_measurements()\n```\n\n\n### Anchoring\n\n```python\nimport datetime as dt\nfrom atlas_df.anchoring import AnchoringMesh\n\nanchoring_mesh = AnchoringMesh()\n\nanchor_fqdn_a = 'al-tia-as42409.anchors.atlas.ripe.net'\nanchor_fqdn_b = 'nc-nou-as56055.anchors.atlas.ripe.net'\nstart_datetime = dt.datetime(2018, 5, 1)\nstop_datetime = dt.datetime(2018, 5, 7)\naf = 4\n\ntraceroute_ab, traceroute_ba = anchoring_mesh.fetch_results(anchor_fqdn_a, anchor_fqdn_b, af, 'traceroute', {'start': START_DATETIME, 'stop': STOP_DATETIME})\n```\n\n### Cache\n\n```python\nimport atlas_df\natlas_df.CACHE_DIR = '.atlas_df'\natlas_df.CACHE_ENABLED = True\n```\n\n## Development\n\n```bash\ngit clone https://github.com/maxmouchet/atlas_df.git\ncd atlas_df\npip install -e .\n```\n\nCode is formatted using [yapf](https://github.com/google/yapf).\n\n### Building documentation\n\n```bash\npip install sphinx sphinx-rtd-theme\nsphinx-apidoc -f -o docs/source/ atlas_df\ncd docs; make html\n```\n\n### Running tests\n\n```bash\npip install -U pytest pytest-cov\npy.test --cov=atlas_df tests/\n```\n\n## Maintainers\n\n[@maxmouchet](https://github.com/maxmouchet)\n\n## Contribute\n\nPRs accepted.\n\n## License\n\nMIT \u00a9 2018 Maxime Mouchet", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/maxmouchet/atlas_df", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "atlas-df", "package_url": "https://pypi.org/project/atlas-df/", "platform": "", "project_url": "https://pypi.org/project/atlas-df/", "project_urls": { "Homepage": "https://github.com/maxmouchet/atlas_df" }, "release_url": "https://pypi.org/project/atlas-df/0.0.4/", "requires_dist": null, "requires_python": "", "summary": "A dataframe-oriented interface to RIPE Atlas.", "version": "0.0.4" }, "last_serial": 4526299, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "da9ff33955500d1e9376ea095b12a247", "sha256": "58f10fc3319519dc839575be60501915d87208ca483811bdec70fc2a8aebba5b" }, "downloads": -1, "filename": "atlas_df-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "da9ff33955500d1e9376ea095b12a247", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3709, "upload_time": "2018-06-05T10:12:12", "url": "https://files.pythonhosted.org/packages/a8/2d/f0004a9fc629cf138406afd1e7e2135992817ee62ecb259a0a7e070f16e3/atlas_df-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49363609d835399820a38af184ca7a43", "sha256": "a56063f76a4f7aaeec5442fd7dab58ed6c0d30a3d5a6be9fdb9f857346f600d0" }, "downloads": -1, "filename": "atlas_df-0.0.1.tar.gz", "has_sig": false, "md5_digest": "49363609d835399820a38af184ca7a43", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2855, "upload_time": "2018-06-05T10:12:13", "url": "https://files.pythonhosted.org/packages/a5/ce/a8fd32c50e03b5602ea3af496acecab5076f5c8b63ca0daa00ada52bf73b/atlas_df-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "c43f19a7c99e7339334239ef5bbd41b1", "sha256": "b52029918a64119efb127b1ab40ce3692216695ad46fc482718033758066b1cc" }, "downloads": -1, "filename": "atlas_df-0.0.2.tar.gz", "has_sig": false, "md5_digest": "c43f19a7c99e7339334239ef5bbd41b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3598, "upload_time": "2018-06-05T20:49:14", "url": "https://files.pythonhosted.org/packages/bb/69/0dca36b625bcae138c258aa1af4020baf95de33a038792996324ba07e94b/atlas_df-0.0.2.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "4ec9407229ea907c94c4351b59718232", "sha256": "13a690f2840109d22a5413ff4e033c5552d22c191f70db37fc919e5b6dc78059" }, "downloads": -1, "filename": "atlas_df-0.0.4.tar.gz", "has_sig": false, "md5_digest": "4ec9407229ea907c94c4351b59718232", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5514, "upload_time": "2018-11-25T14:43:41", "url": "https://files.pythonhosted.org/packages/aa/00/1fcdeeddb2f574b77086601d5e59a4b2009c0a50677de27bd6540fa73256/atlas_df-0.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4ec9407229ea907c94c4351b59718232", "sha256": "13a690f2840109d22a5413ff4e033c5552d22c191f70db37fc919e5b6dc78059" }, "downloads": -1, "filename": "atlas_df-0.0.4.tar.gz", "has_sig": false, "md5_digest": "4ec9407229ea907c94c4351b59718232", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5514, "upload_time": "2018-11-25T14:43:41", "url": "https://files.pythonhosted.org/packages/aa/00/1fcdeeddb2f574b77086601d5e59a4b2009c0a50677de27bd6540fa73256/atlas_df-0.0.4.tar.gz" } ] }