Metadata-Version: 2.1
Name: scamadviser-client
Version: 0.2.0
Summary: A python SDK for ScamAdviser API
Home-page: https://github.com/gogolook-Inc/scamadviser_client
License: MIT
Keywords: scamadviser, sdk, api
Author: Carol H
Author-email: sheseee@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: pydantic (>=1.10.4,<2.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Repository, https://github.com/gogolook-Inc/scamadviser_client
Description-Content-Type: text/markdown

## Installation

```
pip install scamadviser_client
```

or

```
poetry add scamadviser_client
```

## Usage

```python
from scamadviser_client import FeedAPI

api = FeedAPI(apikey=[your_apikey])

api.list(params={"type": "daily"})
api.download(params={"path": "/5-minute/1602245968.json"})
```

## Development

You may install [Nix](https://nixos.org/download.html) to have fully env settings by running `nix-shell`,
or simply use `poetry shell` to bootstrap this package if you would like to join our development.

We also use [justfile](https://github.com/casey/just) to provide some simple commands, you may use

```bash
just default
```

to check all of these available commands.

### start the environment (poetry)

```bash
just up
```

### stop the environment (poetry)

```bash
just down
```

### test

```bash
just test
```

### make the code prettier

```bash
just be-pretty
```

