# Ntropy SDK
This repository hosts the SDK for the Ntropy API. It provides transaction enrichment and categorization, account ledger
and metrics. The full documentation is available at the [developer portal](https://developers.ntropy.com/).
To obtain an API key, you can follow this [guide](https://docs.ntropy.com/onboarding).
## Installation
```bash
$ python3 -m pip install --upgrade 'ntropy-sdk'
```
## Quick Start
Enriching your first transaction requires an `SDK` object and an input `Transaction` object. The API key can be set in
the environment variable `NTROPY_API_KEY` or in the `SDK` constructor:
```python
from ntropy_sdk import SDK
sdk = SDK("YOUR-API-KEY")
r = sdk.transactions.create(
id="4yp49x3tbj9mD8DB4fM8DDY6Yxbx8YP14g565Xketw3tFmn",
description="AMAZON WEB SERVICES",
entry_type="outgoing",
amount=12042.37,
currency="USD",
date="2021-11-01",
location=dict(
country="US"
),
)
print(r)
```
The returned `EnrichedTransaction` contains the added information by Ntropy API. You can consult the Enrichment section
of the documentation for more information on the parameters for both `Transaction` and `EnrichedTransaction`.
## Documentation
You can consult in-depth documentation and examples at
the [developer portal](https://developers.ntropy.com/docs/enrichment) and at
the [SDK reference](https://developers.ntropy.com/sdk).
## License:
Free software: MIT license
Raw data
{
"_id": null,
"home_page": "https://github.com/ntropy-network/ntropy-sdk",
"name": "ntropy-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ntropy_sdk",
"author": "Ntropy",
"author_email": "dev@ntropy.com",
"download_url": "https://files.pythonhosted.org/packages/f9/f9/d702784c30b8b2daee1b2d7e79e6a9d53e1685fca97f30e2c891c874f065/ntropy_sdk-5.1.1.tar.gz",
"platform": null,
"description": "# Ntropy SDK\n\nThis repository hosts the SDK for the Ntropy API. It provides transaction enrichment and categorization, account ledger\nand metrics. The full documentation is available at the [developer portal](https://developers.ntropy.com/).\n\nTo obtain an API key, you can follow this [guide](https://docs.ntropy.com/onboarding).\n\n## Installation\n\n```bash\n$ python3 -m pip install --upgrade 'ntropy-sdk'\n```\n\n## Quick Start\n\nEnriching your first transaction requires an `SDK` object and an input `Transaction` object. The API key can be set in\nthe environment variable `NTROPY_API_KEY` or in the `SDK` constructor:\n\n```python\nfrom ntropy_sdk import SDK\n\nsdk = SDK(\"YOUR-API-KEY\")\nr = sdk.transactions.create(\n id=\"4yp49x3tbj9mD8DB4fM8DDY6Yxbx8YP14g565Xketw3tFmn\",\n description=\"AMAZON WEB SERVICES\",\n entry_type=\"outgoing\",\n amount=12042.37,\n currency=\"USD\",\n date=\"2021-11-01\",\n location=dict(\n country=\"US\"\n ),\n)\nprint(r)\n```\n\nThe returned `EnrichedTransaction` contains the added information by Ntropy API. You can consult the Enrichment section\nof the documentation for more information on the parameters for both `Transaction` and `EnrichedTransaction`.\n\n## Documentation\n\nYou can consult in-depth documentation and examples at\nthe [developer portal](https://developers.ntropy.com/docs/enrichment) and at\nthe [SDK reference](https://developers.ntropy.com/sdk).\n\n## License:\nFree software: MIT license\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "SDK for the Ntropy API",
"version": "5.1.1",
"project_urls": {
"Homepage": "https://github.com/ntropy-network/ntropy-sdk"
},
"split_keywords": [
"ntropy_sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a87a1c02b1f24fd81bc09d9f2b8f106ff6e345feb6fc1402bc4be7e755bc9fd0",
"md5": "cc808c5e391372d6a91fbdc54b4d0e9b",
"sha256": "30b5cb47e1f2ec94aebf01d9546518e659b2ba9d082ba6d6ea2edebe404041dc"
},
"downloads": -1,
"filename": "ntropy_sdk-5.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc808c5e391372d6a91fbdc54b4d0e9b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 48646,
"upload_time": "2024-12-03T19:59:02",
"upload_time_iso_8601": "2024-12-03T19:59:02.200836Z",
"url": "https://files.pythonhosted.org/packages/a8/7a/1c02b1f24fd81bc09d9f2b8f106ff6e345feb6fc1402bc4be7e755bc9fd0/ntropy_sdk-5.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9f9d702784c30b8b2daee1b2d7e79e6a9d53e1685fca97f30e2c891c874f065",
"md5": "3f0f48987ad0ce86c51f36950857d759",
"sha256": "0e7a877ec282ff6e40f89a43b2e6765248e94e0b4a692a8a651416b382807e4d"
},
"downloads": -1,
"filename": "ntropy_sdk-5.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3f0f48987ad0ce86c51f36950857d759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 215019,
"upload_time": "2024-12-03T19:59:03",
"upload_time_iso_8601": "2024-12-03T19:59:03.551098Z",
"url": "https://files.pythonhosted.org/packages/f9/f9/d702784c30b8b2daee1b2d7e79e6a9d53e1685fca97f30e2c891c874f065/ntropy_sdk-5.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 19:59:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ntropy-network",
"github_project": "ntropy-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ntropy-sdk"
}
JSON
