First release of the new jeb core library

2026-03-09 22:17:33 +01:00
parent 4fa98abddd
commit 7c4880a78e
12 changed files with 1343 additions and 0 deletions
@@ -0,0 +1,36 @@
+# jeb-core
+
+The core for jeb 
+
+## Installation
+You can install the library using `pip`:
+
+```bash
+pip install jeb-core --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple
+```
+
+## Usage
+### `JEBCore`
+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 of the new jeb core library