|
| 1 | +# saturnin-sdk |
| 2 | + |
| 3 | +[](https://pypi.org/project/saturnin-sdk) |
| 4 | +[](https://pypi.org/project/saturnin-sdk) |
| 5 | +[](https://github.com/pypa/hatch) |
| 6 | + |
| 7 | +This repository contains SDK for Saturnin, and example services and applications. |
| 8 | + |
| 9 | +----- |
| 10 | + |
| 11 | +**Table of Contents** |
| 12 | + |
| 13 | +- [License](#license) |
| 14 | +- [Installation](#installation) |
| 15 | +- [Documentation](#documentation) |
| 16 | + |
| 17 | +## License |
| 18 | + |
| 19 | +`saturnin` and `saturnin-sdk` are distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +The `saturnin-sdk` package (released on PyPI) contains the SDK itself, without examples. |
| 24 | + |
| 25 | +To work with the SDK, it's necessary to install and properly initialize the `saturnin` |
| 26 | +(see [Saturnin](https://saturnin.rtfd.io/) documentation for details). |
| 27 | + |
| 28 | +Examples are not distributed via PyPI. You can either download the ZIP package from |
| 29 | +[gihub releases](https://github.com/FirebirdSQL/saturnin-sdk/releases) and unpack it into |
| 30 | +directory of your choice, or checkout the "examples" directory directly. |
| 31 | + |
| 32 | +You may also checkout the whole `saturnin-sdk` repository, and install the SDK into your |
| 33 | +Saturnin site directly using: |
| 34 | + |
| 35 | +```console |
| 36 | +saturnin install package -e . |
| 37 | +``` |
| 38 | + |
| 39 | +To register (example and your own) services and application for use with Saturnin in |
| 40 | +"development" mode, use `saturnin install package -e .` from root directory of service |
| 41 | +package. For example to register `TextIO` sample service: |
| 42 | + |
| 43 | +1. CD to `examples/textio` |
| 44 | +2. Run `saturnin install package -e .` |
| 45 | + |
| 46 | +## Documentation |
| 47 | + |
| 48 | +Documentation related to Saturnin: |
| 49 | + |
| 50 | +- [Firebird Butler](https://firebird-butler.rtfd.io/) |
| 51 | +- [Saturnin](https://saturnin.rtfd.io/) |
| 52 | +- [Saturnin CORE](https://saturnin-core.rtfd.io/) services |
| 53 | +- [Saturnin SDK](https://saturnin-sdk.rtfd.io/) |
0 commit comments