Metadata-Version: 2.4
Name: streamstore
Version: 0.1.3
Summary: Python SDK for S2, the Stream Store
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: grpc-stubs>=1.53.0.5
Requires-Dist: grpcio-tools>=1.69.0
Requires-Dist: grpcio>=1.69.0
Requires-Dist: stamina>=24.3.0
Requires-Dist: types-protobuf>=5.29.1.20241207
Provides-Extra: docs
Requires-Dist: enum-tools[sphinx]>=0.12.0; extra == 'docs'
Requires-Dist: furo>=2024.8.6; extra == 'docs'
Requires-Dist: myst-parser>=4.0.0; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints>=3.0.0; extra == 'docs'
Requires-Dist: sphinx>=8.1.3; extra == 'docs'
Description-Content-Type: text/markdown

<div align="center">
  <p>
    <!-- Light mode logo -->
    <a href="https://s2.dev#gh-light-mode-only">
      <img src="./assets/s2-black.png" height="60">
    </a>
    <!-- Dark mode logo -->
    <a href="https://s2.dev#gh-dark-mode-only">
      <img src="./assets/s2-white.png" height="60">
    </a>
  </p>

  <p>
    <!-- PyPI -->
    <a href="https://pypi.org/project/streamstore/"><img src="https://img.shields.io/pypi/v/streamstore" /></a>
    <!-- Read the docs -->
    <a href="https://streamstore.readthedocs.io/"><img src="https://img.shields.io/readthedocs/streamstore/latest" /></a>
    <!-- Discord -->
    <a href="https://discord.gg/vTCs7kMkAf"><img src="https://img.shields.io/discord/1209937852528599092?logo=discord" /></a>
    <!-- LICENSE -->
    <a href="./LICENSE"><img src="https://img.shields.io/github/license/s2-streamstore/s2-sdk-python" /></a>
  </p>
</div>

<!-- start docs index -->

# streamstore

`streamstore` is the Python package that provides an async client for interacting with the [gRPC API](https://s2.dev/docs/interface/grpc) of [S2, the Stream Store](https://s2.dev/).

## Requirements

Python >= 3.11

## Installation

You can install the package from the [Python Package Index](https://pypi.org/project/streamstore) using the package manager of your choice. E.g., with `pip`:

```bash
pip install streamstore
```

## Documentation

API Reference is available at [streamstore.readthedocs.io](https://streamstore.readthedocs.io/).

## Examples

`examples/` directory in the repo contain examples for streaming APIs.

## Get in touch

Join our [Discord](https://discord.gg/vTCs7kMkAf) server. We would love to hear
from you.

You can also email us at [hi@s2.dev](mailto:hi@s2.dev).
