| Name | feldera JSON |
| Version |
0.141.0
JSON |
| download |
| home_page | None |
| Summary | The feldera python client |
| upload_time | 2025-09-10 07:40:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
feldera
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Feldera Python SDK
Feldera Python is the Feldera SDK for Python developers.
## Installation
```bash
uv pip install feldera
```
### Installing from Github
```bash
uv pip install git+https://github.com/feldera/feldera#subdirectory=python
```
Similarly, to install from a specific branch:
```bash
uv pip install git+https://github.com/feldera/feldera@{BRANCH_NAME}#subdirectory=python
```
Replace `{BRANCH_NAME}` with the name of the branch you want to install from.
### Installing from Local Directory
If you have cloned the Feldera repo, you can install the python SDK as follows:
```bash
# the Feldera Python SDK is present inside the python/ directory
cd python
# If you don't have a virtual environment, create one
uv venv
source .venv/activate
# Install the SDK in editable mode
uv pip install .
```
You also have to install the `pytest` module:
```bash
python3 -m pip install pytest
```
## Documentation
The Python SDK documentation is available at
[Feldera Python SDK Docs](https://docs.feldera.com/python).
To build the html documentation run:
Ensure that you have sphinx installed. If not, install it using `uv pip install sphinx`.
Then run the following commands:
```bash
cd docs
sphinx-apidoc -o . ../feldera
make html
```
To clean the build, run `make clean`.
## Linting and formatting
Use [Ruff] to run the lint checks that will be executed by the
precommit hook when a PR is submitted:
```bash
ruff check python/
```
To reformat the code in the same way as the precommit hook:
```bash
ruff format
```
[Ruff]: https://github.com/astral-sh/ruff
Raw data
{
"_id": null,
"home_page": null,
"name": "feldera",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "feldera, python",
"author": null,
"author_email": "Feldera Team <dev@feldera.com>",
"download_url": "https://files.pythonhosted.org/packages/5a/39/5c3108141e0aa710c9b1da2669dea1b3cc3cf4da76b86fd0a583f5e56d14/feldera-0.141.0.tar.gz",
"platform": null,
"description": "# Feldera Python SDK\n\nFeldera Python is the Feldera SDK for Python developers.\n\n## Installation\n\n```bash\nuv pip install feldera\n```\n\n### Installing from Github\n\n```bash\nuv pip install git+https://github.com/feldera/feldera#subdirectory=python\n```\n\nSimilarly, to install from a specific branch:\n\n```bash\nuv pip install git+https://github.com/feldera/feldera@{BRANCH_NAME}#subdirectory=python\n```\n\nReplace `{BRANCH_NAME}` with the name of the branch you want to install from.\n\n### Installing from Local Directory\n\nIf you have cloned the Feldera repo, you can install the python SDK as follows:\n\n```bash\n# the Feldera Python SDK is present inside the python/ directory\ncd python\n# If you don't have a virtual environment, create one\nuv venv\nsource .venv/activate\n# Install the SDK in editable mode\nuv pip install .\n```\n\nYou also have to install the `pytest` module:\n\n```bash\npython3 -m pip install pytest\n```\n\n## Documentation\n\nThe Python SDK documentation is available at\n[Feldera Python SDK Docs](https://docs.feldera.com/python).\n\nTo build the html documentation run:\n\nEnsure that you have sphinx installed. If not, install it using `uv pip install sphinx`.\n\nThen run the following commands:\n\n```bash\ncd docs\nsphinx-apidoc -o . ../feldera\nmake html\n```\n\nTo clean the build, run `make clean`.\n\n## Linting and formatting\n\nUse [Ruff] to run the lint checks that will be executed by the\nprecommit hook when a PR is submitted:\n\n```bash\nruff check python/\n```\n\nTo reformat the code in the same way as the precommit hook:\n\n```bash\nruff format\n```\n\n[Ruff]: https://github.com/astral-sh/ruff\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The feldera python client",
"version": "0.141.0",
"project_urls": {
"Documentation": "https://docs.feldera.com/python",
"Homepage": "https://www.feldera.com",
"Issues": "https://github.com/feldera/feldera/issues",
"Repository": "https://github.com/feldera/feldera"
},
"split_keywords": [
"feldera",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4cc8c87dd89c63448d68d88ba8db8d3541610c22e97787c9950566171a10593f",
"md5": "5822c1107d509b6b9a32861111a80f64",
"sha256": "225b3a476aca7cf21b545782dec40d5be0695899380c3d5d9076cec84b6b71de"
},
"downloads": -1,
"filename": "feldera-0.141.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5822c1107d509b6b9a32861111a80f64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 40735,
"upload_time": "2025-09-10T07:40:13",
"upload_time_iso_8601": "2025-09-10T07:40:13.688516Z",
"url": "https://files.pythonhosted.org/packages/4c/c8/c87dd89c63448d68d88ba8db8d3541610c22e97787c9950566171a10593f/feldera-0.141.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5a395c3108141e0aa710c9b1da2669dea1b3cc3cf4da76b86fd0a583f5e56d14",
"md5": "7598c3ef4357fab7607966226bfe005f",
"sha256": "e2db7b9395bc39936aa0d7195bd3b535347446c636c7423123c0ccc701726d5a"
},
"downloads": -1,
"filename": "feldera-0.141.0.tar.gz",
"has_sig": false,
"md5_digest": "7598c3ef4357fab7607966226bfe005f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 37282,
"upload_time": "2025-09-10T07:40:15",
"upload_time_iso_8601": "2025-09-10T07:40:15.043693Z",
"url": "https://files.pythonhosted.org/packages/5a/39/5c3108141e0aa710c9b1da2669dea1b3cc3cf4da76b86fd0a583f5e56d14/feldera-0.141.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-10 07:40:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "feldera",
"github_project": "feldera",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "feldera"
}
