Skip to main content

Access the IETF Data Tracker and RFC Index

Project description

ietfdata - Access the IETF Datatracker and related resources

This project contains Python 3 libraries to interact with, and access, the IETF datatracker, RFC index, and related resources.

Getting started

The project uses Pipenv for dependency management. To begin, run:

pipenv install --dev -e .

to create a Python virtual environment with appropriate packages install. Then, run:

pipenv shell

to start the virtual environment, within which you can run the scripts.

Once the virtual environment is started, running:

python3 tests/test_datatracker.py 

will run the test suite for the datatracker module. Running:

python3 tests/test_rfcindex.py

Will test the rfcindex module.

Caching

The ietfdata library can use a MongoDB instance as a cache. Using a cache reduces the number of requests that are made directly to the Datatracker, improving performance, and reducing the impact on the IETF's infrastructure. While using a cache is optional when accessing the Datatracker, it is required when accessing the mail archive.

The hostname, port, username, and password for the MongoDB instance that is to be used as the cache can be set when instantiated the DataTracker or MailArchive objects. Alternatively, the following environment variables can be set:

  • IETFDATA_CACHE_HOST (defaults to localhost when accessing the mail archive)
  • IETFDATA_CACHE_PORT (defaults to 27017)
  • IETFDATA_CACHE_USER (optional)
  • IETFDATA_CACHE_PORT (optional)

Release Process

  • Edit CHANGELOG.md and ensure up-to-date
  • Edit setup.py to ensure the correct version number is present
  • Edit ietfdata/datatracker.py to fix version number in DataTracker::ua
  • Commit changes and push to GitHub
  • Run make test to run the test suite. If any tests fail, fix then restart the release process
  • Run python3 setup.py sdist bdist_wheel to prepare the package
  • Run python3 -m twine upload dist/* to upload the package
  • Commit the packages files in dist/* push to GitHub
  • Tag the release in GitHub

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

ietfdata-0.5.5.tar.gz (54.3 kB view details)

Uploaded Source

Built Distribution

ietfdata-0.5.5-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

Details for the file ietfdata-0.5.5.tar.gz.

File metadata

  • Download URL: ietfdata-0.5.5.tar.gz
  • Upload date:
  • Size: 54.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3

File hashes

Hashes for ietfdata-0.5.5.tar.gz
Algorithm Hash digest
SHA256 991e8231b75f799be9b11da092fff709f2a3a7f49bf8490b8e6624edf4deba91
MD5 24daf86f42e81aa9d9adffe5920f9c1b
BLAKE2b-256 bf6890da140463b1d3110c33f4a2f5992e9bae21b28b628140792fa966234b60

See more details on using hashes here.

File details

Details for the file ietfdata-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: ietfdata-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 77.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3

File hashes

Hashes for ietfdata-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 60b0d33a67a3a57ef2776899a90dd8b1878c4833d926723bb0369330a7e3b3ce
MD5 a099321bcbfeedf7749a56548b237c48
BLAKE2b-256 360f9bb6ee6d95ce7a81c05d33d8c01d3c34b519d23d9c63251242edb5bedb89

See more details on using hashes here.

Supported by

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