## 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", "from": "2023-01-01", "to": "2023-01-02"})
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/gogolook-Inc/scamadviser_client",
"name": "scamadviser-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "scamadviser, sdk, api",
"author": "Carol H",
"author_email": "sheseee@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/1a/930b2231c09becdaced0e917515cf83e0576bb0bf32a61d5747ef371fc71/scamadviser_client-0.2.1.tar.gz",
"platform": null,
"description": "## Installation\n\n```\npip install scamadviser_client\n```\n\nor\n\n```\npoetry add scamadviser_client\n```\n\n## Usage\n\n```python\nfrom scamadviser_client import FeedAPI\n\napi = FeedAPI(apikey=[your_apikey])\n\napi.list(params={\"type\": \"daily\", \"from\": \"2023-01-01\", \"to\": \"2023-01-02\"})\napi.download(params={\"path\": \"/5-minute/1602245968.json\"})\n```\n\n## Development\n\nYou may install [Nix](https://nixos.org/download.html) to have fully env settings by running `nix-shell`,\nor simply use `poetry shell` to bootstrap this package if you would like to join our development.\n\nWe also use [justfile](https://github.com/casey/just) to provide some simple commands, you may use\n\n```bash\njust default\n```\n\nto check all of these available commands.\n\n### start the environment (poetry)\n\n```bash\njust up\n```\n\n### stop the environment (poetry)\n\n```bash\njust down\n```\n\n### test\n\n```bash\njust test\n```\n\n### make the code prettier\n\n```bash\njust be-pretty\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python SDK for ScamAdviser API",
"version": "0.2.1",
"split_keywords": [
"scamadviser",
" sdk",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b170a5e199d759b4827e48c66405334df5955810d7361b9c7079fd45131e315",
"md5": "66d7a1c03b013835f787618bae6489d4",
"sha256": "cbdb34ba22139bacd83fa3a07543d275e1da1fadc7974834a8cf9e6555b8df35"
},
"downloads": -1,
"filename": "scamadviser_client-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66d7a1c03b013835f787618bae6489d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 6045,
"upload_time": "2023-01-06T14:03:35",
"upload_time_iso_8601": "2023-01-06T14:03:35.390276Z",
"url": "https://files.pythonhosted.org/packages/8b/17/0a5e199d759b4827e48c66405334df5955810d7361b9c7079fd45131e315/scamadviser_client-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "291a930b2231c09becdaced0e917515cf83e0576bb0bf32a61d5747ef371fc71",
"md5": "a963d8790acb3e4214efd5967f70dad7",
"sha256": "57c902b44d2113c85e90dd34ec0a8d1d911aa040fae5438cddc3131c4235c11e"
},
"downloads": -1,
"filename": "scamadviser_client-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "a963d8790acb3e4214efd5967f70dad7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 4019,
"upload_time": "2023-01-06T14:03:37",
"upload_time_iso_8601": "2023-01-06T14:03:37.951476Z",
"url": "https://files.pythonhosted.org/packages/29/1a/930b2231c09becdaced0e917515cf83e0576bb0bf32a61d5747ef371fc71/scamadviser_client-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-06 14:03:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "gogolook-Inc",
"github_project": "scamadviser_client",
"lcname": "scamadviser-client"
}
JSON
