Skip to content

Commit

Permalink
docs: improve setup instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
ilfa committed Aug 18, 2022
1 parent 3bade18 commit c95f794
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,17 @@ Python 2.7 and 3.4+
## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github
You can install the package directly from Github

```sh
pip install git+https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk.git`)

Or from PyPI

```sh
pip install fingerprint_pro_server_api_sdk
```

Then import the package:
```python
Expand Down
9 changes: 7 additions & 2 deletions template/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,17 @@ Python 2.7 and 3.4+
## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github
You can install the package directly from the Github

```sh
pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git`)

Or from the PyPI

```sh
pip install {{{packageName}}}
```

Then import the package:
```python
Expand Down

0 comments on commit c95f794

Please sign in to comment.