Skip to main content

Downloads ROA info solely for research purposes

Project description

Informational Badges:

PyPI version PyPy PyPI - Python Version Tests Linux macOS Intel macOS ARM Windows

Some Linting Badges (Where I could find them):

Ruff Code style: black Checked with mypy Imports: isort Pylint try/except style: tryceratops

roa_collector

If you like the repo, it would be awesome if you could add a star to it! It really helps out the visibility. Also for any questions at all we'd love to hear from you at jfuruness@gmail.com

Package Description

Downloads ROAs from https://rpki-validator.ripe.net/api/export.json, inserts them in a CSV, and returns them as a list of ROA dataclasses (containing asn, prefix, max_length, and ta properties, where ta is RIPE, afrinic, etc)

Usage

from a script:

from pathlib import Path

from roa_collector import ROACollector

csv_path = Path("/tmp/my_csv_path.csv")  # or set to None to avoid writing
roas = ROACollector(csv_path).run()

Installation

Install python and pip if you have not already.

Then run:

# Needed for graphviz and Pillow
pip3 install pip --upgrade
pip3 install wheel

For production:

pip3 install roa_collector

This will install the package and all of it's python dependencies.

If you want to install the project for development:

git clone https://github.com/jfuruness/roa_collector.git
cd roa_collector
pip3 install -e .[test]
pre-commit install

To test the development package: Testing

Testing

To test the package after installation:

cd roa_collector
pytest roa_collector
ruff check roa_collector
ruff format roa_collector
mypy roa_collector

If you want to run it across multiple environments, and have python 3.10 and 3.11 installed:

cd roa_collector
tox --skip-missing-interpreters

Development/Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Test it
  4. Run tox
  5. Commit your changes: git commit -am 'Add some feature'
  6. Push to the branch: git push origin my-new-feature
  7. Ensure github actions are passing tests
  8. Email me at jfuruness@gmail.com if it's been a while and I haven't seen it

License

BSD License (see license file)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roa_collector-2.0.5.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

roa_collector-2.0.5-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file roa_collector-2.0.5.tar.gz.

File metadata

  • Download URL: roa_collector-2.0.5.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for roa_collector-2.0.5.tar.gz
Algorithm Hash digest
SHA256 3e94560007e8ef3ceb50437f2d77404a608540cf5f4b1f39e35b9c387f56c6d7
MD5 3493619718c3e1ffc202a576bf223283
BLAKE2b-256 e4c14a1029746c3d0b8bd6bdbabaad03458199af828e755c169fbadb30453afd

See more details on using hashes here.

File details

Details for the file roa_collector-2.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for roa_collector-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 343c866ebc3887d5eb389d72747a405ffa4d17851de14f7e350547f6552991a6
MD5 8a2bcc2385f02db0a860810321beb0d8
BLAKE2b-256 2275a462dd5323e0abafc1b2dae7fe38d09b373384769e127f50211f3c5a4d39

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page