First release

2026-02-28 02:05:18 +01:00
parent 650d8083a3
commit 1bf7c97cbd
14 changed files with 1023 additions and 0 deletions
@@ -0,0 +1,35 @@
+# jeb-server-utils
+
+The utilities for the jeb server
+
+## Installation
+You can install the library using `pip`:
+
+```bash
+pip install jeb-server-utils --index-url https://repo.jcloud-services.ddns.net/simple/
+```
+
+## Usage
+### `JEBServerUtils`
+The main class. It has following methods:
+- `get_segment_base_timestamp`: Returns the base timestamp of a segment.
+- `get_topics`: Returns all topics.
+- `mktopic`: Creates a topic.
+- `rmtopic`: Removes a topic.
+- `mktopicpart`: Creates a partition of a topic.
+- `rmtopicpart`: Removes a partition of a topic.
+- `check_topic_exists`: Checks whether a topic exists (raises an exception if not).
+- `create_record`: Creates a record.
+- `fetch_records`: Fetches records from the topic and yields them in chunks.
+
+### `Topic`
+A topic.
+
+### `Segment`:
+A segment.
+
+For more details, see the function and method docstrings.
+
+## Changelog
+### Version 0.1.0
+- First release