Metadata-Version: 2.4
Name: kaspa
Version: 1.1.0rc1
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: maturin>=1.0,<2.0 ; extra == 'dev'
Requires-Dist: pytest>=8.0 ; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23 ; extra == 'dev'
Requires-Dist: click==8.2.1 ; extra == 'docs'
Requires-Dist: mkdocs>=1.6 ; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5 ; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.26 ; extra == 'docs'
Requires-Dist: mkdocs-gen-files>=0.5 ; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.6 ; extra == 'docs'
Requires-Dist: mike>=2.1 ; extra == 'docs'
Provides-Extra: dev
Provides-Extra: docs
License-File: LICENSE
Summary: Kaspa Python SDK
Keywords: kaspa,cryptocurrency,blockchain,blockdag,sdk,wallet,rpc
Author: Kaspa developers
License-Expression: ISC
Requires-Python: >=3.10, <=3.14
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://smartgoo.github.io/kaspa-python-sdk/latest/CHANGELOG/
Project-URL: Documentation, https://smartgoo.github.io/kaspa-python-sdk/latest
Project-URL: Homepage, https://github.com/smartgoo/kaspa-python-sdk
Project-URL: Issues, https://github.com/smartgoo/kaspa-python-sdk/issues
Project-URL: Repository, https://github.com/smartgoo/kaspa-python-sdk

# Kaspa Python SDK

> [!WARNING]
> **This project is beta status, not intended for use in critical applications/environments.**
> 
> Kasa Python SDK source has historically lived [here](https://github.com/aspectron/rusty-kaspa/tree/python). The current `kaspa` PyPi package is built from that source.
>
> This repository is the potential future home of Kaspa Python SDK source. It has reached parity (feature, stability, etc.) with the existing codebase.
> 
> **You can build/install the `kaspa` Python package from this repository. See instructions [here](https://smartgoo.github.io/kaspa-python-sdk/dev/getting-started/installation/#installation-from-source).**

---

The Kaspa Python SDK provides bindings to Rust & [Rusty-Kaspa](https://github.com/kaspanet/rusty-kaspa) source for use in Python applications. Allowing Python developers to interact with the Kaspa BlockDAG.

A native extension module, `kaspa`, is built from these bindings using [PyO3](https://pyo3.rs/v0.20.0/) and [Maturin](https://www.maturin.rs).

## Features

This SDK provides features in two primary categories:

- RPC Client - Connect to Kaspa nodes via RPC.
- Wallet Management - Wallet related functionality (key management, derivation, addresses, transactions, etc.).

Most feature gaps with Kaspa WASM SDK exist around Wallet functionality. Over time, features will be added to the Kaspa Python SDK to bring it as close as possible.

## Documentation

Full documentation is available on the [documentation site](https://smartgoo.github.io/kaspa-python-sdk/dev/), including:

- [Installation Guide](https://smartgoo.github.io/kaspa-python-sdk/dev/getting-started/installation/)
- [Examples](https://smartgoo.github.io/kaspa-python-sdk/dev/getting-started/examples/)
- [API Reference](https://smartgoo.github.io/kaspa-python-sdk/dev/reference/)

And more.

## Quick Install

```bash
pip install kaspa
```

## Example

A very basic example:

```python
import asyncio
from kaspa import Resolver, RpcClient

async def main():
    client = RpcClient(resolver=Resolver())
    await client.connect()
    print(await client.get_server_info())

if __name__ == "__main__":
    asyncio.run(main())
```


## Contributing & Core Concepts

The [Contributing Guide](https://smartgoo.github.io/kaspa-python-sdk/dev/contributing/) details various technical core concepts and workflows used by this project.

## License

This project is licensed under the ISC License.

