Skip to content

Commit

Permalink
Merge pull request #6 from mdukef5/patch-1
Browse files Browse the repository at this point in the history
Fixed README mistakes
  • Loading branch information
martinduke authored Sep 17, 2021
2 parents 5519035 + a7a9657 commit ebb72a6
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,28 @@ A simple python tool to identify the contributions to RFCs for any IETF particip

* Any document where the attempt to retrieve from the rfc-editor or datatracker failed for some reason.

Just type
'''
Change the parameters in the first code block, then just type
```sh
python3 count-rfcs.py
'''

To run it.

Change the parameters in the first code block to input the correct names.
```
to run it.

These parameters also affect the speed at which things run. Every RFC that is not discarded due to being the wrong status, date, or area takes about 1 second to process, so if there are no filters whatsoever 10,000 RFC's will take ~3 hours.

Parameters:
* name: how the name would appear in the datatracker, or in a acknowledgements section (usually '[first name] [last name]')
* name: how the name would appear in the datatracker, or in an acknowledgements section (usually '[first name] [last name]')

* include_informational, include_experimental: set to False if you don't care about documents with this status

* include_acknowledgments: if True, the script will download and search the document itself to find your name

* first_year: the first year an RFC might of been published that the person affected (set to 1969 or earlier to disable)
* first_year: the first year an RFC might have been published that the person affected (set to 1969 or earlier to disable)

* first_rfc: the earliest RFC number the person might have affected (set to 0000 to disable)

* last_rfc: skip over all RFC numbers beyond this (mostly useful for debugging)

* first_ad_year: the first year someone was an AD; before that year, the tool does not check if the person balloted on a draft. To disable, set it to a future year. Also, after first_ad_year the script ignores any limits on area, stream, or wg
The script will process an RFC that matches ANY of the lists below
* first_ad_year: the first year someone was an AD; before that year, the tool does not check if the person balloted on a draft. To disable, set it to a future year. Also, after first_ad_year the script ignores any limits on area, stream, or wg. Prior to first_ad_year, the script will process an RFC that matches ANY of the three lists below:

* streams: before first_ad_year, the tool will check any RFC from this stream

Expand Down

0 comments on commit ebb72a6

Please sign in to comment.