diff --git a/tools/hawk/README.md b/tools/hawk/README.md index caaa6807..7b0bf853 100644 --- a/tools/hawk/README.md +++ b/tools/hawk/README.md @@ -1,6 +1,6 @@ # Make a Hawk compatible Auth header -The best way to install this is probably to set up a python virtual +1) The best way to install this is probably to set up a python virtual env. `python3 -m venv venv && venv/bin/pip install -r requirements.txt` @@ -9,4 +9,16 @@ this will create a python virtual environment in the `/venv` directory. *Note* You may need to install `python3-venv` for the above to work. -Use `-h` for help. \ No newline at end of file +Once the virtual env is installed, run `. venv/bin/activate`. This +will ensure that calls to python and python tools happen within this +virutal environment. + +2) install the requirements using: + +`venv/bin/pip install -r requirements.txt` + +3) To create a Token Header: + +`venv/bin/python make_hawk_token.py` + +Use `-h` for help.