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 tolocalhostwhen accessing the mail archive)IETFDATA_CACHE_PORT(defaults to27017)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 testto run the test suite. If any tests fail, fix then restart the release process - Run
python3 setup.py sdist bdist_wheelto 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
1 maintainer
Metadata
1 maintainer
Release files for ietfdata 0.5.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ietfdata-0.5.6.tar.gz | 55.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ietfdata-0.5.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 136.3 kB
Release files / ietfdata-0.5.6.tar.gz
| Download URL | ietfdata-0.5.6.tar.gz |
|---|---|
| Size | 55.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
024efacaca80c4410b25dc321be917f3131682de1355b7e25660ec8a9d313bd1
|
|
BLAKE2b-256 checksum How to use checksums |
9e7550e0713927f688f0f152d31a649d91f5665fea54f74f633789a6e7ec8fca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / ietfdata-0.5.6-py3-none-any.whl
| Download URL | ietfdata-0.5.6-py3-none-any.whl |
|---|---|
| Size | 80.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
802c3b1bf71b4a71c56f7c00f2bf6d6e59b276065423c6a35cfbc1af9445535f
|
|
BLAKE2b-256 checksum How to use checksums |
497bbe4c15dd915871d69554016adb8f39161d842e9d39c33c733def56182164
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
