@@ -41,7 +41,8 @@ The following guide is for members of the project team who have access to the re
41
41
### Prerequisites
42
42
43
43
- Python 3.x
44
- - GitHub API access token (optional, but recommended for higher rate limits)
44
+ - GitHub Personal Access Token (optional, but highly recommended for higher rate limits)
45
+ > ** _ Create a PAT:_ ** GitHub -> Settings -> Developer Settings -> Personal Access Tokens
45
46
46
47
### Installation
47
48
@@ -56,10 +57,11 @@ cd codejson-index-generator
56
57
pip install PyGithub
57
58
```
58
59
59
- 3 . Set up your GitHub API token _ (optional but recommended) _ :
60
+ 1 . Set up your GitHub Personal Access Token :
60
61
``` bash
61
62
export GITHUB_KEY=" your-token-here"
62
63
```
64
+ > ** _ NOTE:_ ** _ Use of GitHub PAT is highly recommened due to rate limiting._
63
65
64
66
### Usage
65
67
@@ -69,7 +71,7 @@ The script can be run from the command line with the following options:
69
71
python main.py --agency AGENCY_NAME --orgs " org1,org2" --output code.json --version VERSION_NUMBER
70
72
```
71
73
72
- _ Seperate organizations by comma without any spaces!_
74
+ > ** _ NOTE: _ ** _ Seperate organizations by comma without any spaces!_
73
75
74
76
##### Required arguments:
75
77
- ` --agency ` : The name of your agency
@@ -81,9 +83,8 @@ _Seperate organizations by comma without any spaces!_
81
83
82
84
##### Example:
83
85
``` bash
84
- python main.py --agency CMS --orgs " DSACMS,CMSgov,CMS-Enterprise" --output code.json --version 1.0.0
86
+ python3 main.py --agency CMS --orgs " DSACMS,CMSgov,CMS-Enterprise" --output code.json --version 1.0.0
85
87
```
86
- _ The "python" keyword may be different depending on what version you have installed. (e.g. python3)_
87
88
88
89
## Coding Style and Linters
89
90
0 commit comments