Access the IETF Data Tracker and RFC Index
ietfdata - Access the IETF Datatracker and related resources
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:
to start the virtual environment, within which you can run the scripts.
Once the virtual environment is started, running:
will run the test suite for the datatracker module. Running:
Will test the rfcindex module.
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
MailArchive objects. Alternatively, the following environment variables can be
localhostwhen accessing the mail archive)
- 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
make testto 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).
python3 setup.py sdist bdist_wheelto prepare the package
python3 -m twine upload dist/*to upload the package
- Commit the packages files in
dist/*push to GitHub
- Tag the release in GitHub
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.