Skip to content

Commit

Permalink
chore: update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
codebender committed Aug 18, 2023
1 parent 6eeff4a commit 801be97
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 15 deletions.
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ pex:
poetry export --without-hashes > ${REQUIREMENTS}
poetry run pex -r ${REQUIREMENTS} -e authum.cli:main -o dist/athm .

install:
cp dist/athm /usr/local/bin

release:
$(eval VERSION=`poetry version -s`)
git tag -a v${VERSION} -m "Release version ${VERSION}"
Expand Down
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,15 @@ SAML/OIDC identity and service providers. Authum is the successor to
## Installation

1. Install [Poetry](https://python-poetry.org)
- `brew install poetry`
1. Clone this repository
1. `cd /path/to/repository`
1. `poetry install`
1. `make pex`
1. `make install`
1. Copy `dist/athm` to a location in $PATH
- Homebrewers `cp dist/athm $(eval brew --prefix)/bin`
1. `rehash` to update binaries in `$PATH`

### Graphical Prompts

[tkinter](https://docs.python.org/3/library/tkinter.html) is required for
graphical prompts.

#### Homebrew on macOS

```sh
brew install python-tk
```

## Example Usage: Generate Temporary IAM Credentials via Identity Provider Credentials

See [aws](authum/plugins/aws/) plugin documentation.
Expand Down

0 comments on commit 801be97

Please sign in to comment.