Skip to content

Commit e94f79c

Browse files
committed
Describe need for GitHub API token in README.md
1 parent 595a9b4 commit e94f79c

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ In addition to Python and the dependencies listed above, the following programs
7979
* [`git`](https://git-scm.com/) (version 2.7.4 or later)
8080
* [`pip`](https://pip.pypa.io/) (version 19.3.1 or later)
8181

82-
A [GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required *in an upcoming iteration*, because the Python scripts will use it for GitHub API queries.
82+
A [GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required top be available as an environmental variable. This is because the Python scripts will use it for GitHub API queries. This token is an alphanumeric string in the form of "ghp_2D5TYFikFsQ4U9KPfzHyvigMycePCPqkPgWc".
8383

8484
### Running from source
8585

@@ -125,9 +125,11 @@ Replace the command `podman` with `docker` depending on which one is available (
125125
Then, the run the container on port 8000 at 127.0.0.1 with this command:
126126

127127
```sh
128-
podman run --env PORT=8000 -p 127.0.0.1:8000:8000 wp22dev
128+
podman run --env PORT=8000 --env GITHUB_TOKEN=[token] -p 127.0.0.1:8000:8000 -d wp22dev
129129
```
130130

131+
Where `token` is the 40 character alphanumeric string of your GitHub API personal access token. It is in the form of "ghp_2D5TYFikFsQ4U9KPfzHyvigMycePCPqkPgWc".
132+
131133
The image built this way can be pushed to cloud hosting providers such as [Heroku](https://www.heroku.com/). With Heroku as an example:
132134

133135
1. Set up an empty app from your Heroku dashboard.

0 commit comments

Comments
 (0)