Metadata-Version: 2.1
Name: ietfdata
Version: 0.3.3
Summary: Access the IETF Data Tracker and RFC Index
Home-page: https://github.com/glasgow-ipl/ietfdata
Author: Colin Perkins
Author-email: csp@csperkins.org
License: UNKNOWN
Description: ietf-data - Access the IETF DataTracker and related resources
        =============================================================
        
        https://github.com/glasgow-ipl/ietfdata
        
        This project contains Python 3 libraries to interact with, and
        access, the (IETF data tracker)[https://datatracker.ietf.org], 
        (RFC index)[https://www.rfc-editor.org], and related resources.
        
        
        
        Getting started
        ---------------
        
        The project uses Pipenv for dependency management. To begin, run:
        ```~~~~~~~~
        pipenv install --dev
        ```
        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.
        
        
        
        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
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
