graphsense-python 2.10.0__tar.gz → 2.12.0__tar.gz

{graphsense_python-2.10.0 → graphsense_python-2.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphsense-python
-Version: 2.10.0
+Version: 2.12.0
 Summary: GraphSense API
 Author-email: Iknaio Cryptoasset Analytics GmbH <contact@iknaio.com>
 License-Expression: MIT
@@ -15,14 +15,50 @@ Requires-Dist: urllib3<3.0.0,>=2.1.0
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: cli
+Requires-Dist: rich-click>=1.7; extra == "cli"
+Requires-Dist: jmespath>=1.0; extra == "cli"
+Requires-Dist: pygments>=2.15; extra == "cli"
 
 # graphsense-python
-GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, entities, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.
+GraphSense API provides programmatic access to blockchain analytics data across
+multiple ledgers. Use it to explore addresses, clusters, blocks, transactions,
+tags, token activity, and exchange-rate context, and to integrate investigation
+workflows into your own applications and automation.
+
+## Versioning and deprecation policy
+
+The API follows semantic versioning. Minor releases are additive and
+backwards-compatible; breaking changes only happen in major releases, which
+are rare and announced in advance.
+
+Deprecated endpoints and fields remain fully functional for at least six
+months after they are marked deprecated. During that window they are
+highlighted with a strikethrough in the docs and in generated clients, and
+responses from deprecated endpoints carry a `Deprecation` HTTP header that
+client tooling can detect. Replacement endpoints and fields are always
+introduced before the deprecated surface is removed.
+
+See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy)
+for details.
+
+
+## Using the high-level wrapper or CLI
+
+Two hand-written convenience layers ride on top of the generated client
+(both protected from regeneration via `.openapi-generator-ignore`):
+
+- **Python** — [`README_EXT.md`](README_EXT.md) documents
+  `graphsense.ext.GraphSense`, a single facade that removes boilerplate and
+  bundles commonly-paired calls (ships with the base install).
+- **Shell** — [`README_CLI.md`](README_CLI.md) documents the `graphsense` CLI
+  (installed via `uv add 'graphsense-python[cli]'`): pipe-friendly,
+  JSON/CSV I/O, auto-bulk.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2.10.0
-- Package version: 2.10.0
+- API version: 2.12.0
+- Package version: 2.12.0
 - Generator version: 7.19.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.iknaio.com/](https://www.iknaio.com/)
@@ -32,37 +68,39 @@ For more information, please visit [https://www.iknaio.com/](https://www.iknaio.
 Python 3.9+
 
 ## Installation & Usage
-### pip install
 
-If the python package is hosted on a repository, you can install directly using:
+This project uses [uv](https://docs.astral.sh/uv/) for environment and
+dependency management.
+
+### Add to a uv project
 
 ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+uv add graphsense-python
+# or, to include the optional `[cli]` extra (installs the `graphsense` CLI):
+uv add 'graphsense-python[cli]'
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
 
-Then import the package:
-```python
-import graphsense
-```
+### Install from git
 
-### Setuptools
+```sh
+uv add 'git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+```
 
-Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+### One-off script usage
 
 ```sh
-python setup.py install --user
+uv run --with graphsense-python python my_script.py
 ```
-(or `sudo python setup.py install` to install the package for all users)
 
 Then import the package:
+
 ```python
 import graphsense
 ```
 
 ### Tests
 
-Execute `pytest` to run the tests.
+Execute `uv run pytest` to run the tests.
 
 ## Getting Started
 
@@ -117,6 +155,7 @@ All URIs are relative to *https://api.iknaio.com*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *AddressesApi* | [**get_address**](docs/AddressesApi.md#get_address) | **GET** /{currency}/addresses/{address} | Get an address
+*AddressesApi* | [**get_address_cluster**](docs/AddressesApi.md#get_address_cluster) | **GET** /{currency}/addresses/{address}/cluster | Get the cluster for an address
 *AddressesApi* | [**get_address_entity**](docs/AddressesApi.md#get_address_entity) | **GET** /{currency}/addresses/{address}/entity | Get the entity for an address
 *AddressesApi* | [**get_tag_summary_by_address**](docs/AddressesApi.md#get_tag_summary_by_address) | **GET** /{currency}/addresses/{address}/tag_summary | Get address attribution tag summary
 *AddressesApi* | [**list_address_links**](docs/AddressesApi.md#list_address_links) | **GET** /{currency}/addresses/{address}/links | List transactions between two addresses
@@ -129,6 +168,13 @@ Class | Method | HTTP request | Description
 *BlocksApi* | [**list_block_txs**](docs/BlocksApi.md#list_block_txs) | **GET** /{currency}/blocks/{height}/txs | List transactions in a block
 *BulkApi* | [**bulk_csv**](docs/BulkApi.md#bulk_csv) | **POST** /{currency}/bulk.csv/{operation} | Stream bulk operation results as CSV
 *BulkApi* | [**bulk_json**](docs/BulkApi.md#bulk_json) | **POST** /{currency}/bulk.json/{operation} | Stream bulk operation results as JSON
+*ClustersApi* | [**get_cluster**](docs/ClustersApi.md#get_cluster) | **GET** /{currency}/clusters/{cluster} | Get cluster details
+*ClustersApi* | [**list_address_tags_by_cluster**](docs/ClustersApi.md#list_address_tags_by_cluster) | **GET** /{currency}/clusters/{cluster}/tags | List cluster address tags
+*ClustersApi* | [**list_cluster_addresses**](docs/ClustersApi.md#list_cluster_addresses) | **GET** /{currency}/clusters/{cluster}/addresses | List cluster addresses
+*ClustersApi* | [**list_cluster_links**](docs/ClustersApi.md#list_cluster_links) | **GET** /{currency}/clusters/{cluster}/links | List transactions between clusters
+*ClustersApi* | [**list_cluster_neighbors**](docs/ClustersApi.md#list_cluster_neighbors) | **GET** /{currency}/clusters/{cluster}/neighbors | List neighboring clusters
+*ClustersApi* | [**list_cluster_txs**](docs/ClustersApi.md#list_cluster_txs) | **GET** /{currency}/clusters/{cluster}/txs | List cluster transactions
+*ClustersApi* | [**search_cluster_neighbors**](docs/ClustersApi.md#search_cluster_neighbors) | **GET** /{currency}/clusters/{cluster}/search | Search cluster neighborhood
 *EntitiesApi* | [**get_entity**](docs/EntitiesApi.md#get_entity) | **GET** /{currency}/entities/{entity} | Get entity details
 *EntitiesApi* | [**list_address_tags_by_entity**](docs/EntitiesApi.md#list_address_tags_by_entity) | **GET** /{currency}/entities/{entity}/tags | List entity address tags
 *EntitiesApi* | [**list_entity_addresses**](docs/EntitiesApi.md#list_entity_addresses) | **GET** /{currency}/entities/{entity}/addresses | List entity addresses
@@ -169,6 +215,8 @@ Class | Method | HTTP request | Description
  - [Block](docs/Block.md)
  - [BlockAtDate](docs/BlockAtDate.md)
  - [ChangeHeuristics](docs/ChangeHeuristics.md)
+ - [Cluster](docs/Cluster.md)
+ - [ClusterAddresses](docs/ClusterAddresses.md)
  - [CoinJoinConsensus](docs/CoinJoinConsensus.md)
  - [CoinJoinHeuristics](docs/CoinJoinHeuristics.md)
  - [Concept](docs/Concept.md)
@@ -190,6 +238,8 @@ Class | Method | HTTP request | Description
  - [MultiInputChangeHeuristic](docs/MultiInputChangeHeuristic.md)
  - [NeighborAddress](docs/NeighborAddress.md)
  - [NeighborAddresses](docs/NeighborAddresses.md)
+ - [NeighborCluster](docs/NeighborCluster.md)
+ - [NeighborClusters](docs/NeighborClusters.md)
  - [NeighborEntities](docs/NeighborEntities.md)
  - [NeighborEntity](docs/NeighborEntity.md)
  - [OneTimeChangeHeuristic](docs/OneTimeChangeHeuristic.md)
@@ -245,4 +295,3 @@ Authentication schemes defined for the API:
 
 contact@iknaio.com
 
-

{graphsense_python-2.10.0 → graphsense_python-2.12.0}/README.md

@@ -1,10 +1,42 @@
 # graphsense-python
-GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, entities, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.
+GraphSense API provides programmatic access to blockchain analytics data across
+multiple ledgers. Use it to explore addresses, clusters, blocks, transactions,
+tags, token activity, and exchange-rate context, and to integrate investigation
+workflows into your own applications and automation.
+
+## Versioning and deprecation policy
+
+The API follows semantic versioning. Minor releases are additive and
+backwards-compatible; breaking changes only happen in major releases, which
+are rare and announced in advance.
+
+Deprecated endpoints and fields remain fully functional for at least six
+months after they are marked deprecated. During that window they are
+highlighted with a strikethrough in the docs and in generated clients, and
+responses from deprecated endpoints carry a `Deprecation` HTTP header that
+client tooling can detect. Replacement endpoints and fields are always
+introduced before the deprecated surface is removed.
+
+See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy)
+for details.
+
+
+## Using the high-level wrapper or CLI
+
+Two hand-written convenience layers ride on top of the generated client
+(both protected from regeneration via `.openapi-generator-ignore`):
+
+- **Python** — [`README_EXT.md`](README_EXT.md) documents
+  `graphsense.ext.GraphSense`, a single facade that removes boilerplate and
+  bundles commonly-paired calls (ships with the base install).
+- **Shell** — [`README_CLI.md`](README_CLI.md) documents the `graphsense` CLI
+  (installed via `uv add 'graphsense-python[cli]'`): pipe-friendly,
+  JSON/CSV I/O, auto-bulk.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2.10.0
-- Package version: 2.10.0
+- API version: 2.12.0
+- Package version: 2.12.0
 - Generator version: 7.19.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.iknaio.com/](https://www.iknaio.com/)
@@ -14,37 +46,39 @@ For more information, please visit [https://www.iknaio.com/](https://www.iknaio.
 Python 3.9+
 
 ## Installation & Usage
-### pip install
 
-If the python package is hosted on a repository, you can install directly using:
+This project uses [uv](https://docs.astral.sh/uv/) for environment and
+dependency management.
+
+### Add to a uv project
 
 ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+uv add graphsense-python
+# or, to include the optional `[cli]` extra (installs the `graphsense` CLI):
+uv add 'graphsense-python[cli]'
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
 
-Then import the package:
-```python
-import graphsense
-```
+### Install from git
 
-### Setuptools
+```sh
+uv add 'git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+```
 
-Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+### One-off script usage
 
 ```sh
-python setup.py install --user
+uv run --with graphsense-python python my_script.py
 ```
-(or `sudo python setup.py install` to install the package for all users)
 
 Then import the package:
+
 ```python
 import graphsense
 ```
 
 ### Tests
 
-Execute `pytest` to run the tests.
+Execute `uv run pytest` to run the tests.
 
 ## Getting Started
 
@@ -99,6 +133,7 @@ All URIs are relative to *https://api.iknaio.com*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *AddressesApi* | [**get_address**](docs/AddressesApi.md#get_address) | **GET** /{currency}/addresses/{address} | Get an address
+*AddressesApi* | [**get_address_cluster**](docs/AddressesApi.md#get_address_cluster) | **GET** /{currency}/addresses/{address}/cluster | Get the cluster for an address
 *AddressesApi* | [**get_address_entity**](docs/AddressesApi.md#get_address_entity) | **GET** /{currency}/addresses/{address}/entity | Get the entity for an address
 *AddressesApi* | [**get_tag_summary_by_address**](docs/AddressesApi.md#get_tag_summary_by_address) | **GET** /{currency}/addresses/{address}/tag_summary | Get address attribution tag summary
 *AddressesApi* | [**list_address_links**](docs/AddressesApi.md#list_address_links) | **GET** /{currency}/addresses/{address}/links | List transactions between two addresses
@@ -111,6 +146,13 @@ Class | Method | HTTP request | Description
 *BlocksApi* | [**list_block_txs**](docs/BlocksApi.md#list_block_txs) | **GET** /{currency}/blocks/{height}/txs | List transactions in a block
 *BulkApi* | [**bulk_csv**](docs/BulkApi.md#bulk_csv) | **POST** /{currency}/bulk.csv/{operation} | Stream bulk operation results as CSV
 *BulkApi* | [**bulk_json**](docs/BulkApi.md#bulk_json) | **POST** /{currency}/bulk.json/{operation} | Stream bulk operation results as JSON
+*ClustersApi* | [**get_cluster**](docs/ClustersApi.md#get_cluster) | **GET** /{currency}/clusters/{cluster} | Get cluster details
+*ClustersApi* | [**list_address_tags_by_cluster**](docs/ClustersApi.md#list_address_tags_by_cluster) | **GET** /{currency}/clusters/{cluster}/tags | List cluster address tags
+*ClustersApi* | [**list_cluster_addresses**](docs/ClustersApi.md#list_cluster_addresses) | **GET** /{currency}/clusters/{cluster}/addresses | List cluster addresses
+*ClustersApi* | [**list_cluster_links**](docs/ClustersApi.md#list_cluster_links) | **GET** /{currency}/clusters/{cluster}/links | List transactions between clusters
+*ClustersApi* | [**list_cluster_neighbors**](docs/ClustersApi.md#list_cluster_neighbors) | **GET** /{currency}/clusters/{cluster}/neighbors | List neighboring clusters
+*ClustersApi* | [**list_cluster_txs**](docs/ClustersApi.md#list_cluster_txs) | **GET** /{currency}/clusters/{cluster}/txs | List cluster transactions
+*ClustersApi* | [**search_cluster_neighbors**](docs/ClustersApi.md#search_cluster_neighbors) | **GET** /{currency}/clusters/{cluster}/search | Search cluster neighborhood
 *EntitiesApi* | [**get_entity**](docs/EntitiesApi.md#get_entity) | **GET** /{currency}/entities/{entity} | Get entity details
 *EntitiesApi* | [**list_address_tags_by_entity**](docs/EntitiesApi.md#list_address_tags_by_entity) | **GET** /{currency}/entities/{entity}/tags | List entity address tags
 *EntitiesApi* | [**list_entity_addresses**](docs/EntitiesApi.md#list_entity_addresses) | **GET** /{currency}/entities/{entity}/addresses | List entity addresses
@@ -151,6 +193,8 @@ Class | Method | HTTP request | Description
  - [Block](docs/Block.md)
  - [BlockAtDate](docs/BlockAtDate.md)
  - [ChangeHeuristics](docs/ChangeHeuristics.md)
+ - [Cluster](docs/Cluster.md)
+ - [ClusterAddresses](docs/ClusterAddresses.md)
  - [CoinJoinConsensus](docs/CoinJoinConsensus.md)
  - [CoinJoinHeuristics](docs/CoinJoinHeuristics.md)
  - [Concept](docs/Concept.md)
@@ -172,6 +216,8 @@ Class | Method | HTTP request | Description
  - [MultiInputChangeHeuristic](docs/MultiInputChangeHeuristic.md)
  - [NeighborAddress](docs/NeighborAddress.md)
  - [NeighborAddresses](docs/NeighborAddresses.md)
+ - [NeighborCluster](docs/NeighborCluster.md)
+ - [NeighborClusters](docs/NeighborClusters.md)
  - [NeighborEntities](docs/NeighborEntities.md)
  - [NeighborEntity](docs/NeighborEntity.md)
  - [OneTimeChangeHeuristic](docs/OneTimeChangeHeuristic.md)
@@ -227,4 +273,3 @@ Authentication schemes defined for the API:
 
 contact@iknaio.com
 
-

{graphsense_python-2.10.0 → graphsense_python-2.12.0}/graphsense/__init__.py

@@ -5,20 +5,21 @@
 """
     GraphSense API
 
-    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, entities, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  # noqa: E501
+    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, clusters, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  ## Versioning and deprecation policy  The API follows semantic versioning. Minor releases are additive and backwards-compatible; breaking changes only happen in major releases, which are rare and announced in advance.  Deprecated endpoints and fields remain fully functional for at least six months after they are marked deprecated. During that window they are highlighted with a strikethrough in the docs and in generated clients, and responses from deprecated endpoints carry a `Deprecation` HTTP header that client tooling can detect. Replacement endpoints and fields are always introduced before the deprecated surface is removed.  See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy) for details.   # noqa: E501
 
     Contact: contact@iknaio.com
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "2.10.0"
+__version__ = "2.12.0"
 
 # Define package exports
 __all__ = [
     "AddressesApi",
     "BlocksApi",
     "BulkApi",
+    "ClustersApi",
     "EntitiesApi",
     "GeneralApi",
     "RatesApi",
@@ -46,6 +47,8 @@ __all__ = [
     "Block",
     "BlockAtDate",
     "ChangeHeuristics",
+    "Cluster",
+    "ClusterAddresses",
     "CoinJoinConsensus",
     "CoinJoinHeuristics",
     "Concept",
@@ -67,6 +70,8 @@ __all__ = [
     "MultiInputChangeHeuristic",
     "NeighborAddress",
     "NeighborAddresses",
+    "NeighborCluster",
+    "NeighborClusters",
     "NeighborEntities",
     "NeighborEntity",
     "OneTimeChangeHeuristic",
@@ -112,6 +117,7 @@ import graphsense.compat  # noqa: F401
 from graphsense.api.addresses_api import AddressesApi as AddressesApi
 from graphsense.api.blocks_api import BlocksApi as BlocksApi
 from graphsense.api.bulk_api import BulkApi as BulkApi
+from graphsense.api.clusters_api import ClustersApi as ClustersApi
 from graphsense.api.entities_api import EntitiesApi as EntitiesApi
 from graphsense.api.general_api import GeneralApi as GeneralApi
 from graphsense.api.rates_api import RatesApi as RatesApi
@@ -143,6 +149,8 @@ from graphsense.models.address_txs import AddressTxs as AddressTxs
 from graphsense.models.block import Block as Block
 from graphsense.models.block_at_date import BlockAtDate as BlockAtDate
 from graphsense.models.change_heuristics import ChangeHeuristics as ChangeHeuristics
+from graphsense.models.cluster import Cluster as Cluster
+from graphsense.models.cluster_addresses import ClusterAddresses as ClusterAddresses
 from graphsense.models.coin_join_consensus import CoinJoinConsensus as CoinJoinConsensus
 from graphsense.models.coin_join_heuristics import CoinJoinHeuristics as CoinJoinHeuristics
 from graphsense.models.concept import Concept as Concept
@@ -164,6 +172,8 @@ from graphsense.models.location_inner import LocationInner as LocationInner
 from graphsense.models.multi_input_change_heuristic import MultiInputChangeHeuristic as MultiInputChangeHeuristic
 from graphsense.models.neighbor_address import NeighborAddress as NeighborAddress
 from graphsense.models.neighbor_addresses import NeighborAddresses as NeighborAddresses
+from graphsense.models.neighbor_cluster import NeighborCluster as NeighborCluster
+from graphsense.models.neighbor_clusters import NeighborClusters as NeighborClusters
 from graphsense.models.neighbor_entities import NeighborEntities as NeighborEntities
 from graphsense.models.neighbor_entity import NeighborEntity as NeighborEntity
 from graphsense.models.one_time_change_heuristic import OneTimeChangeHeuristic as OneTimeChangeHeuristic

{graphsense_python-2.10.0 → graphsense_python-2.12.0}/graphsense/api/__init__.py

@@ -4,6 +4,7 @@
 from graphsense.api.addresses_api import AddressesApi
 from graphsense.api.blocks_api import BlocksApi
 from graphsense.api.bulk_api import BulkApi
+from graphsense.api.clusters_api import ClustersApi
 from graphsense.api.entities_api import EntitiesApi
 from graphsense.api.general_api import GeneralApi
 from graphsense.api.rates_api import RatesApi