apache-iggy 0.9.0.dev1__tar.gz → 0.9.0.dev2__tar.gz

{apache_iggy-0.9.0.dev1 → apache_iggy-0.9.0.dev2}/Cargo.toml

@@ -61,7 +61,6 @@ members = [
     "core/partitions",
     "core/sdk",
     "core/server",
-    "core/server-ng",
     "core/server_common",
     "core/shard",
     "core/shard_allocator",
@@ -200,11 +199,11 @@ hyper-util = { version = "0.1.20", features = ["server-auto", "service"] }
 iceberg = "0.9.1"
 iceberg-catalog-rest = "0.9.1"
 iceberg-storage-opendal = "0.9.1"
-iggy = { path = "core/sdk", version = "0.11.0-edge.1" }
-iggy-cli = { path = "core/cli", version = "0.14.0-edge.1" }
-iggy_binary_protocol = { path = "core/binary_protocol", version = "0.11.0-edge.1" }
-iggy_common = { path = "core/common", version = "0.11.0-edge.1" }
-iggy_connector_sdk = { path = "core/connectors/sdk", version = "0.3.1-edge.1" }
+iggy = { path = "core/sdk", version = "0.11.0-edge.2" }
+iggy-cli = { path = "core/cli", version = "0.14.0-edge.2" }
+iggy_binary_protocol = { path = "core/binary_protocol", version = "0.11.0-edge.2" }
+iggy_common = { path = "core/common", version = "0.11.0-edge.2" }
+iggy_connector_sdk = { path = "core/connectors/sdk", version = "0.4.0-edge.1" }
 indexmap = "2.14.0"
 integration = { path = "core/integration" }
 ipnet = "2.12.0"
@@ -295,7 +294,6 @@ serde_with = { version = "3.21.0", features = ["base64", "macros"] }
 serde_yaml_ng = "0.10.0"
 serial_test = "3.5.0"
 server = { path = "core/server" }
-server-ng = { path = "core/server-ng" }
 server_common = { path = "core/server_common" }
 shard = { path = "core/shard" }
 shard_allocator = { path = "core/shard_allocator" }

{apache_iggy-0.9.0.dev1 → apache_iggy-0.9.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apache-iggy
-Version: 0.9.0.dev1
+Version: 0.9.0.dev2
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -24,7 +24,7 @@ Requires-Dist: pytest-cov>=4.0,<8.0 ; extra == 'all'
 Requires-Dist: pytest-xdist>=3.0,<4.0 ; extra == 'all'
 Requires-Dist: pytest-timeout>=2.0,<3.0 ; extra == 'all'
 Requires-Dist: ruff>=0.1.0,<1.0 ; extra == 'all'
-Requires-Dist: testcontainers>=3.7.0,<5.0 ; extra == 'all'
+Requires-Dist: testcontainers>=4.15.0,<5.0 ; extra == 'all'
 Requires-Dist: maturin>=1.14.1,<2.0 ; extra == 'dev'
 Requires-Dist: pyrefly>=1.1.1 ; extra == 'dev'
 Requires-Dist: ruff>=0.1.0,<1.0 ; extra == 'dev'
@@ -33,7 +33,7 @@ Requires-Dist: pytest-asyncio>=0.24.0,<2.0 ; extra == 'testing'
 Requires-Dist: pytest-cov>=4.0,<8.0 ; extra == 'testing'
 Requires-Dist: pytest-xdist>=3.0,<4.0 ; extra == 'testing'
 Requires-Dist: pytest-timeout>=2.0,<3.0 ; extra == 'testing'
-Requires-Dist: testcontainers>=3.7.0,<5.0 ; extra == 'testing-docker'
+Requires-Dist: testcontainers>=4.15.0,<5.0 ; extra == 'testing-docker'
 Provides-Extra: all
 Provides-Extra: dev
 Provides-Extra: testing
@@ -76,7 +76,7 @@ Apache Iggy is the persistent message streaming platform written in Rust, suppor
 ### Basic Installation
 
 ```bash
-# Using uv
+# Using uv in an existing project
 uv add apache-iggy
 
 # Using pip
@@ -85,30 +85,147 @@ source .venv/bin/activate
 pip install apache-iggy
 ```
 
-### Supported Python Versions
+### Prerequisites
+
+Every installation below compiles the Rust extension, so you'll need:
 
 - Python 3.10+
+- Rust toolchain: `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
+- `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+- All checks tooling from [CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
+- Docker
 
 ### Local Development
 
-```bash
-# Start server for testing using docker
-docker compose -f docker-compose.test.yml up --build
+**IMPORTANT: All commands are supposed to be ran from `foreign/python` unless it's specified to run in repository's root folder.**
 
-# Or use cargo
-cargo run --bin iggy-server -- --with-default-root-credentials --fresh
+1. Build a project for development
 
-# Using uv:
-uv sync --all-extras
-uv run maturin develop
-uv run pytest tests/ -v # Run tests (requires iggy-server running)
+   With `uv`:
 
-# Using pip:
-python3 -m venv .venv
-source .venv/bin/activate
-pip install -e ".[all]"
-maturin develop
-pytest tests/ -v # Run tests (requires iggy-server running)
+   ```bash
+   # Create a venv
+   uv venv
+
+   # Sync the environment without updating it
+   uv sync --frozen --all-extras --no-install-project
+
+   # Build the project -- this builds the rust extension into the venv (debug profile) - re-run after any rust change
+   uv run --no-sync maturin develop
+   ```
+
+   With `pip`:
+
+   ```bash
+   # Create a venv
+   python3 -m venv .venv
+
+   # Activate the venv
+   source .venv/bin/activate
+
+   # Install the dependencies
+   pip install -e ".[all]"
+
+   # Build the project -- this builds the rust extension into the venv (debug profile) - re-run after any rust change
+   maturin develop
+   ```
+
+2. Run the server to be able to run the tests (this blocks the terminal - run steps 3-5 in a separate one). `--fresh` deletes `local_data/` on every run - drop it if you have existing data you want to keep.
+
+   ```bash
+   # run from the repository's root directory
+   cargo run --bin iggy-server -- --with-default-root-credentials --fresh
+   ```
+
+3. Run the tests
+
+   `uv`:
+
+   ```bash
+   uv run --no-sync pytest tests/ -v
+   ```
+
+   `pip`:
+
+   ```bash
+   pytest tests/ -v # make sure iggy-server is running and the venv is activated
+   ```
+
+4. To update the stubs, only after changing the pyo3 API surface (nothing in CI checks stub freshness, so unconditional regen just invites `.pyi` churn), use
+
+   ```bash
+   # run from foreign/python
+   cargo run --bin stub_gen
+   # TODO: Known bug: running this from a subdirectory of `foreign/python` corrupts the tracked stub, see https://github.com/apache/iggy/pull/3825/changes/BASE..773a27971b4ddb7b44773ded395ed23afb1de4c9#r3727691619
+   ```
+
+5. Before committing, test the pre-commit and pre-push hooks. `prek` only inspects staged content, so stage your work first:
+
+   ```bash
+   git add -A
+   prek run # runs pre-commit hooks
+   prek run --hook-stage pre-push
+   # if a hook modifies files, re-run `git add -A` and `prek run`.
+   ```
+
+   These are some of the essential commands prek is running, so it's recommended to run them manually before
+running prek / committing / pushing. This list is not exhaustive and other hook failures are possible.
+
+   ```bash
+   uv run --no-sync ruff format .
+   ```
+
+   ```bash
+   uv run --no-sync ruff check --fix .
+   ```
+
+   ```bash
+   cargo fmt --manifest-path Cargo.toml
+   ```
+
+   ```bash
+   cargo clippy --manifest-path Cargo.toml --all-targets --all-features -- -D warnings
+   ```
+
+   ```bash
+   # run from the repository's root directory
+   ./scripts/ci/markdownlint.sh --fix foreign/python/README.md # read the diff after applying this, sometimes it gives unwanted results, e.g. messing up enumerations
+   ```
+
+## Client Configuration
+
+`IggyClient` takes either a server address or a `TcpConfig`:
+
+```python
+import asyncio
+from datetime import timedelta
+
+from apache_iggy import AutoLogin, IggyClient, TcpConfig, TcpReconnectionConfig
+
+
+async def main():
+    client = IggyClient(
+        TcpConfig(
+            server_address="127.0.0.1:8090",
+            auto_login=AutoLogin.username_password("iggy", "iggy"),
+            reconnection=TcpReconnectionConfig(
+                enabled=True,
+                max_retries=10,
+                interval=timedelta(seconds=2),
+                reestablish_after=timedelta(seconds=30),
+            ),
+            heartbeat_interval=timedelta(seconds=5),
+            # tls_enabled=True,
+            # tls_domain="localhost",
+            # tls_ca_file="../../core/certs/iggy_ca_cert.pem",
+            # tls_validate_certificate=True,
+            # nodelay=True,
+        )
+    )
+    await client.connect()
+
+
+asyncio.run(main())
 ```
 
 ## Examples
@@ -117,7 +234,7 @@ Refer to the [examples/python/](https://github.com/apache/iggy/tree/master/examp
 
 ## Contributing
 
-See [CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/foreign/python/CONTRIBUTING.md) for development setup and guidelines.
+See [CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md) for contribution guidelines.
 
 ## License
 

apache_iggy-0.9.0.dev2/README.md

@@ -0,0 +1,188 @@
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/apache/iggy/refs/heads/master/assets/logo/SVG/iggy-apache-color-darkbg.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/apache/iggy/refs/heads/master/assets/logo/SVG/iggy-apache-color-lightbg.svg">
+    <img alt="Apache Iggy" src="https://raw.githubusercontent.com/apache/iggy/refs/heads/master/assets/logo/SVG/iggy-apache-color-lightbg.svg" width="320">
+  </picture>
+</div>
+
+# apache-iggy
+
+[![discord-badge](https://img.shields.io/discord/1144142576266530928)](https://discord.gg/C5Sux5NcRa)
+
+Apache Iggy is the persistent message streaming platform written in Rust, supporting QUIC, TCP and HTTP transport protocols, capable of processing millions of messages per second.
+
+> Apache Iggy (Incubating) is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC.
+>
+> Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects.
+>
+> While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+
+## Installation
+
+### Basic Installation
+
+```bash
+# Using uv in an existing project
+uv add apache-iggy
+
+# Using pip
+python3 -m venv .venv
+source .venv/bin/activate
+pip install apache-iggy
+```
+
+### Prerequisites
+
+Every installation below compiles the Rust extension, so you'll need:
+
+- Python 3.10+
+- Rust toolchain: `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
+- `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+- All checks tooling from [CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
+- Docker
+
+### Local Development
+
+**IMPORTANT: All commands are supposed to be ran from `foreign/python` unless it's specified to run in repository's root folder.**
+
+1. Build a project for development
+
+   With `uv`:
+
+   ```bash
+   # Create a venv
+   uv venv
+
+   # Sync the environment without updating it
+   uv sync --frozen --all-extras --no-install-project
+
+   # Build the project -- this builds the rust extension into the venv (debug profile) - re-run after any rust change
+   uv run --no-sync maturin develop
+   ```
+
+   With `pip`:
+
+   ```bash
+   # Create a venv
+   python3 -m venv .venv
+
+   # Activate the venv
+   source .venv/bin/activate
+
+   # Install the dependencies
+   pip install -e ".[all]"
+
+   # Build the project -- this builds the rust extension into the venv (debug profile) - re-run after any rust change
+   maturin develop
+   ```
+
+2. Run the server to be able to run the tests (this blocks the terminal - run steps 3-5 in a separate one). `--fresh` deletes `local_data/` on every run - drop it if you have existing data you want to keep.
+
+   ```bash
+   # run from the repository's root directory
+   cargo run --bin iggy-server -- --with-default-root-credentials --fresh
+   ```
+
+3. Run the tests
+
+   `uv`:
+
+   ```bash
+   uv run --no-sync pytest tests/ -v
+   ```
+
+   `pip`:
+
+   ```bash
+   pytest tests/ -v # make sure iggy-server is running and the venv is activated
+   ```
+
+4. To update the stubs, only after changing the pyo3 API surface (nothing in CI checks stub freshness, so unconditional regen just invites `.pyi` churn), use
+
+   ```bash
+   # run from foreign/python
+   cargo run --bin stub_gen
+   # TODO: Known bug: running this from a subdirectory of `foreign/python` corrupts the tracked stub, see https://github.com/apache/iggy/pull/3825/changes/BASE..773a27971b4ddb7b44773ded395ed23afb1de4c9#r3727691619
+   ```
+
+5. Before committing, test the pre-commit and pre-push hooks. `prek` only inspects staged content, so stage your work first:
+
+   ```bash
+   git add -A
+   prek run # runs pre-commit hooks
+   prek run --hook-stage pre-push
+   # if a hook modifies files, re-run `git add -A` and `prek run`.
+   ```
+
+   These are some of the essential commands prek is running, so it's recommended to run them manually before
+running prek / committing / pushing. This list is not exhaustive and other hook failures are possible.
+
+   ```bash
+   uv run --no-sync ruff format .
+   ```
+
+   ```bash
+   uv run --no-sync ruff check --fix .
+   ```
+
+   ```bash
+   cargo fmt --manifest-path Cargo.toml
+   ```
+
+   ```bash
+   cargo clippy --manifest-path Cargo.toml --all-targets --all-features -- -D warnings
+   ```
+
+   ```bash
+   # run from the repository's root directory
+   ./scripts/ci/markdownlint.sh --fix foreign/python/README.md # read the diff after applying this, sometimes it gives unwanted results, e.g. messing up enumerations
+   ```
+
+## Client Configuration
+
+`IggyClient` takes either a server address or a `TcpConfig`:
+
+```python
+import asyncio
+from datetime import timedelta
+
+from apache_iggy import AutoLogin, IggyClient, TcpConfig, TcpReconnectionConfig
+
+
+async def main():
+    client = IggyClient(
+        TcpConfig(
+            server_address="127.0.0.1:8090",
+            auto_login=AutoLogin.username_password("iggy", "iggy"),
+            reconnection=TcpReconnectionConfig(
+                enabled=True,
+                max_retries=10,
+                interval=timedelta(seconds=2),
+                reestablish_after=timedelta(seconds=30),
+            ),
+            heartbeat_interval=timedelta(seconds=5),
+            # tls_enabled=True,
+            # tls_domain="localhost",
+            # tls_ca_file="../../core/certs/iggy_ca_cert.pem",
+            # tls_validate_certificate=True,
+            # nodelay=True,
+        )
+    )
+    await client.connect()
+
+
+asyncio.run(main())
+```
+
+## Examples
+
+Refer to the [examples/python/](https://github.com/apache/iggy/tree/master/examples/python) directory for usage examples.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md) for contribution guidelines.
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](https://github.com/apache/iggy/blob/master/foreign/python/LICENSE) for details.