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
  • Run make test to run the test suite. If any tests fail, fix then restart the release process
  • Commit changes and push to GitHub
  • Check that the GitHub Continuous Integration run succeeds, and fix any problems (this runs with a fresh cache, so can sometimes catch problems that aren't found by local tests).
  • 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.6.4.tar.gz (50.6 kB view details)

Uploaded Source

Built Distribution

ietfdata-0.6.4-py3-none-any.whl (106.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ietfdata-0.6.4.tar.gz
  • Upload date:
  • Size: 50.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.11

File hashes

Hashes for ietfdata-0.6.4.tar.gz
Algorithm Hash digest
SHA256 6023a9a508c95d853053b61ba9bb28ca621631c2fef999361a1ff35ece830794
MD5 2a396c8114731a88282e7d128465d2ea
BLAKE2b-256 a8877236ef43d9fe91c4a1851b40c94e5d9cc20dd49bae231f661087a0f6dea0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ietfdata-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 106.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.11

File hashes

Hashes for ietfdata-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 237a20b774dbe7225d7f015ade86e8b4ee5b4ffe7bace8dda00461aba23c5ed1
MD5 962e9280c72016176b19c8448895148e
BLAKE2b-256 9b8ab6e16120167a8f6722a4d144c303966b4571a80a6502291c36eb79aca271

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