| Name | feldera JSON |
| Version |
0.28.0
JSON |
| download |
| home_page | None |
| Summary | The feldera python client |
| upload_time | 2024-10-16 19:29:20 |
| 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
pip install feldera
```
### Installing from Github
```bash
pip install git+https://github.com/feldera/feldera#subdirectory=python
```
Similarly, to install from a specific branch:
```bash
$ 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
pip install python/
```
Checkout the docs [here](./feldera/__init__.py) for an example on how to use the SDK.
## Documentation
To build the html documentation run:
Ensure that you have sphinx installed. If not, install it using `pip install sphinx`.
Then run the following commands:
```bash
cd docs
sphinx-apidoc -o . ../feldera
make html
```
To clean the build, run `make clean`.
## Testing
To run unit tests:
```bash
(cd python && python3 -m unittest)
```
The following command runs end-to-end tests. You'll need a pipeline
manager running at `http://localhost:8080`. For the pipeline builder
tests, you'll also need a broker available at `localhost:9092` and
(from the pipelines) `redpanda:19092`. (To change those locations,
set the environment variables listed in `python/tests/__init__.py`.)
```bash
(cd python/tests && python3 -m pytest .)
```
To run tests from a specific file:
```bash
(cd python/tests && python3 -m unittest ./tests/path-to-file.py)
```
To run the aggregate tests use:
```bash
cd python
PYTHONPATH=`pwd` python3 ./tests/aggregate_tests/main.py
```
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": "Abhinav <abhinav.gyawali@feldera.com>",
"download_url": "https://files.pythonhosted.org/packages/f0/20/7236c72f3d2c67742172680bd4dba9081c8bb08b0f5268a6a5c258ee7051/feldera-0.28.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\npip install feldera\n```\n\n### Installing from Github\n\n```bash\npip install git+https://github.com/feldera/feldera#subdirectory=python\n```\n\nSimilarly, to install from a specific branch:\n\n```bash\n$ 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\npip install python/\n```\n\nCheckout the docs [here](./feldera/__init__.py) for an example on how to use the SDK.\n\n## Documentation\n\nTo build the html documentation run:\n\nEnsure that you have sphinx installed. If not, install it using `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## Testing\n\nTo run unit tests:\n\n```bash\n(cd python && python3 -m unittest)\n```\n\nThe following command runs end-to-end tests. You'll need a pipeline\nmanager running at `http://localhost:8080`. For the pipeline builder\ntests, you'll also need a broker available at `localhost:9092` and\n(from the pipelines) `redpanda:19092`. (To change those locations,\nset the environment variables listed in `python/tests/__init__.py`.)\n\n```bash\n(cd python/tests && python3 -m pytest .)\n```\n\nTo run tests from a specific file:\n\n```bash\n(cd python/tests && python3 -m unittest ./tests/path-to-file.py)\n```\n\nTo run the aggregate tests use:\n\n```bash\ncd python\nPYTHONPATH=`pwd` python3 ./tests/aggregate_tests/main.py\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The feldera python client",
"version": "0.28.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": "",
"digests": {
"blake2b_256": "c4d17dcc846ced5ef4e3e4eace0cf0b57243f25511ccd410702e45333b206ad3",
"md5": "56fe70efad922f0ac54354083c25d5e9",
"sha256": "8a56e7df4a29c31cf52d356b58f64d10823fbc2d724d98740026a26790fa5bf7"
},
"downloads": -1,
"filename": "feldera-0.28.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56fe70efad922f0ac54354083c25d5e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22568,
"upload_time": "2024-10-16T19:29:19",
"upload_time_iso_8601": "2024-10-16T19:29:19.122703Z",
"url": "https://files.pythonhosted.org/packages/c4/d1/7dcc846ced5ef4e3e4eace0cf0b57243f25511ccd410702e45333b206ad3/feldera-0.28.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0207236c72f3d2c67742172680bd4dba9081c8bb08b0f5268a6a5c258ee7051",
"md5": "313be8019b69e9c3823d60cb211e7d67",
"sha256": "7916c397f6a016ccd7efb747f2e27a5ad651e70ded062be6d080c693bc873dcf"
},
"downloads": -1,
"filename": "feldera-0.28.0.tar.gz",
"has_sig": false,
"md5_digest": "313be8019b69e9c3823d60cb211e7d67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 26329,
"upload_time": "2024-10-16T19:29:20",
"upload_time_iso_8601": "2024-10-16T19:29:20.076536Z",
"url": "https://files.pythonhosted.org/packages/f0/20/7236c72f3d2c67742172680bd4dba9081c8bb08b0f5268a6a5c258ee7051/feldera-0.28.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 19:29:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "feldera",
"github_project": "feldera",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "feldera"
}
