Skip to content

Commit

Permalink
feat: project init && user functionalities
Browse files Browse the repository at this point in the history
  • Loading branch information
Emmarex committed Dec 18, 2021
1 parent 5822de7 commit c9cfea0
Show file tree
Hide file tree
Showing 13 changed files with 787 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,5 @@ dmypy.json

# Pyre type checker
.pyre/

examples/
20 changes: 20 additions & 0 deletions .pre-commit-config.yaml
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)
54 changes: 53 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,53 @@
# thepeer-sdk-python
# Thepeer Python SDK

![GitHub issues](https://img.shields.io/github/issues/Emmarex/thepeer-sdk-python)
![PyPI - Downloads](https://img.shields.io/pypi/dm/thepeer-sdk)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](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.
Loading

0 comments on commit c9cfea0

Please sign in to comment.