-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: project init && user functionalities
- Loading branch information
Showing
13 changed files
with
787 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -127,3 +127,5 @@ dmypy.json | |
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
examples/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# See https://pre-commit.com for more information | ||
# See https://pre-commit.com/hooks.html for more hooks | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v3.2.0 | ||
hooks: | ||
- id: trailing-whitespace | ||
- id: end-of-file-fixer | ||
- id: check-yaml | ||
|
||
- repo: https://github.com/pre-commit/mirrors-autopep8 | ||
rev: v1.4.4 | ||
hooks: | ||
- id: autopep8 | ||
|
||
- repo: https://github.com/pycqa/isort | ||
rev: 5.8.0 | ||
hooks: | ||
- id: isort | ||
name: isort (python) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,53 @@ | ||
# thepeer-sdk-python | ||
# Thepeer Python SDK | ||
|
||
 | ||
 | ||
[](https://github.com/pre-commit/pre-commit) | ||
|
||
Python SDK for [Thepeer](https://thepeer.co/). | ||
|
||
## Quick Start | ||
|
||
1. Install thepeer-sdk | ||
|
||
```bash | ||
pip install thepeer-sdk | ||
``` | ||
|
||
2. Signup to get your API keys [here](https://dashboard.thepeer.co/login) | ||
|
||
## Usage | ||
|
||
|
||
### Initiate | ||
```python | ||
from thepeer_sdk import ThepeerSdkClient | ||
|
||
thepeer_sdk_client = ThepeerSdkClient( | ||
secret_key="SECRET_KEY_GOES_HERE" | ||
) | ||
|
||
# Get the list of all indexed users | ||
thepeer_sdk_client.list_users() | ||
``` | ||
|
||
### Available Methods | ||
#### User | ||
- index_user | ||
- list_users | ||
- update_user | ||
- delete_user | ||
|
||
## Upgrade | ||
|
||
```bash | ||
pip install --upgrade thepeer-sdk | ||
``` | ||
|
||
## Extra | ||
|
||
Visit the official [Thepeer documentation](https://docs.thepeer.co/) for more information. | ||
|
||
|
||
## License | ||
See LICENSE. |
Oops, something went wrong.