Metadata-Version: 2.4
Name: bitcaster-sdk
Version: 0.3
Summary: Bitcaster Python SDK
Project-URL: Homepage, https://github.com/bitcaster-io/bitcaster-sdk
Project-URL: Repository, https://github.com/bitcaster-io/bitcaster-sdk
Author-email: sax <s.apostolico@gmail.com>, mark <hanarero@gmail.com>
Maintainer-email: sax <s.apostolico@gmail.com>, mark <hanarero@gmail.com>
License: MIT
Classifier: Programming Language :: Python :: 3 :: Only
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
Requires-Python: >=3.10
Requires-Dist: click
Requires-Dist: humanfriendly
Requires-Dist: requests
Description-Content-Type: text/markdown

Bitcaster Python SDK
--------------------

[![Test](https://github.com/bitcaster-io/bitcaster-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/bitcaster-io/bitcaster-sdk/actions/workflows/test.yml)
[![codecov](https://codecov.io/github/bitcaster-io/bitcaster-sdk/graph/badge.svg?token=gZTNDaXB57)](https://codecov.io/github/bitcaster-io/bitcaster-sdk)
[![Pypi](https://badge.fury.io/py/bitcaster-sdk.svg)](https://badge.fury.io/py/bitcaster-sdk)


How to use it:

Setup environment

- Set Bitcaster application-end-point using Bitcaster Key, get it at <bc_instance>/o/<org>/a/<app>/key/

    ```
    export BITCASTER_BAE=http://<KEY>@<SERVER>/api/o/<organization_slug>/

    ```

- in your code

    ```
    import bitcaster_sdk
    bitcaster_sdk.init()
    from bitcaster_sdk import trigger
    trigger(
        "project-slug", "application-slug", "event-slug",
        context={}
    )
    ```



- from command line

    ```
    $ bitcaster
    Usage: bitcaster [OPTIONS] COMMAND [ARGS]...

    Options:
      --bae BAE  Bitcaster BAE. Not needed if $BITCASTER_BAE is set
      --debug
      --help     Show this message and exit.

    Commands:
      events   lists Application's Events
      lists    lists Project's DistributionList
      members  lists DistributionList Members
      ping     ping Bitcaster server
      trigger  trigger Application's Event
      users    displays Organization's Users

    ```
