# OpenBAS client for Python
[](https://openbas.io)
[](https://circleci.com/gh/OpenBAS-Platform/client-python/tree/main)
[](https://openbas-client-for-python.readthedocs.io/en/latest/)
[](https://github.com/OpenBAS-Platform/client-python/releases/latest)
[](https://pypi.python.org/pypi/pyobas/)
[](https://community.filigran.io)
The official OpenBAS Python client helps developers to use the OpenBAS API by providing easy to use methods and utils.
This client is also used by some OpenBAS components.
## Install
To install the latest Python client library, please use `pip`:
```bash
$ pip3 install pyobas
```
## Local development
```bash
# Fork the current repository, then clone your fork
$ git clone https://github.com/YOUR-USERNAME/client-python
$ cd client-python
$ git remote add upstream https://github.com/OpenBAS-Platform/client-python.git
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ python3 -m venv .venv
$ source .venv/bin/activate
# Install the client-python and dependencies for the development and the documentation
$ python3 -m pip install -e .[dev,doc]
# Set up the git hook scripts
$ pre-commit install
# Create your feature/fix
# Create tests for your changes
$ python -m unittest
# Push you feature/fix on Github
$ git add [file(s)]
$ git commit -m "[descriptive message]"
$ git push origin [branch-name]
# Open a pull request
```
### Install the package locally
```bash
$ pip install -e .
```
## Documentation
### Client usage
To learn about how to use the OpenBAS Python client and read some examples and cases, refer to [the client documentation](https://openbas-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).
### API reference
To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://openbas-client-for-python.readthedocs.io/en/latest/pyobas/pyobas.html).
## Tests
The standard `unittest` library is used for running the tests.
```bash
$ python -m unittest
```
## Code Coverage
To run the tests and generate a code coverage report:
```bash
pytest --cov=. tests/
```
## About
OpenBAS is a product designed and developed by the company [Filigran](https://filigran.io).
<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenBAS-Platform/openbas/raw/master/.github/img/logo_filigran.png" width="300" /></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenBAS-Platform/client-python",
"name": "pyobas",
"maintainer": "Filigran",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Filigran",
"author_email": "contact@filigran.io",
"download_url": "https://files.pythonhosted.org/packages/51/3f/4188e709b08e64d16be62fca72b302c3267c0ef95b9ecea8184108a8c2eb/pyobas-1.17.3.tar.gz",
"platform": null,
"description": "# OpenBAS client for Python\n\n[](https://openbas.io)\n[](https://circleci.com/gh/OpenBAS-Platform/client-python/tree/main)\n[](https://openbas-client-for-python.readthedocs.io/en/latest/)\n[](https://github.com/OpenBAS-Platform/client-python/releases/latest)\n[](https://pypi.python.org/pypi/pyobas/)\n[](https://community.filigran.io)\n\nThe official OpenBAS Python client helps developers to use the OpenBAS API by providing easy to use methods and utils.\nThis client is also used by some OpenBAS components.\n\n## Install\n\nTo install the latest Python client library, please use `pip`:\n\n```bash\n$ pip3 install pyobas\n```\n\n## Local development\n\n```bash\n# Fork the current repository, then clone your fork\n$ git clone https://github.com/YOUR-USERNAME/client-python\n$ cd client-python\n$ git remote add upstream https://github.com/OpenBAS-Platform/client-python.git\n# Create a branch for your feature/fix\n$ git checkout -b [branch-name]\n# Create a virtualenv\n$ python3 -m venv .venv\n$ source .venv/bin/activate\n# Install the client-python and dependencies for the development and the documentation\n$ python3 -m pip install -e .[dev,doc]\n# Set up the git hook scripts\n$ pre-commit install\n# Create your feature/fix\n# Create tests for your changes\n$ python -m unittest\n# Push you feature/fix on Github\n$ git add [file(s)]\n$ git commit -m \"[descriptive message]\"\n$ git push origin [branch-name]\n# Open a pull request\n```\n\n### Install the package locally\n\n```bash\n$ pip install -e .\n```\n\n## Documentation\n\n### Client usage\n\nTo learn about how to use the OpenBAS Python client and read some examples and cases, refer to [the client documentation](https://openbas-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).\n\n### API reference\n\nTo learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://openbas-client-for-python.readthedocs.io/en/latest/pyobas/pyobas.html).\n\n## Tests\n\nThe standard `unittest` library is used for running the tests.\n\n```bash\n$ python -m unittest\n```\n\n## Code Coverage\n\nTo run the tests and generate a code coverage report:\n\n```bash\npytest --cov=. tests/\n```\n\n## About\n\nOpenBAS is a product designed and developed by the company [Filigran](https://filigran.io).\n\n<a href=\"https://filigran.io\" alt=\"Filigran\"><img src=\"https://github.com/OpenBAS-Platform/openbas/raw/master/.github/img/logo_filigran.png\" width=\"300\" /></a>\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Python API client for OpenBAS.",
"version": "1.17.3",
"project_urls": {
"Homepage": "https://github.com/OpenBAS-Platform/client-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8dbc3a6eb0727e105e72a6cc94c37a9de829fec27da3f5f7bc8bc245a123eba1",
"md5": "99c75fbf4d411e09019c3a00b121ea32",
"sha256": "7fbfadc02ef697af082060582f6eaee32c9f94192389dc08ff1008659d60eb98"
},
"downloads": -1,
"filename": "pyobas-1.17.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99c75fbf4d411e09019c3a00b121ea32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 49649,
"upload_time": "2025-07-09T07:53:22",
"upload_time_iso_8601": "2025-07-09T07:53:22.903846Z",
"url": "https://files.pythonhosted.org/packages/8d/bc/3a6eb0727e105e72a6cc94c37a9de829fec27da3f5f7bc8bc245a123eba1/pyobas-1.17.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "513f4188e709b08e64d16be62fca72b302c3267c0ef95b9ecea8184108a8c2eb",
"md5": "680d692e0c9a510e069242638ae9c344",
"sha256": "fead81e034c6d5ab5bba8d8ecbc2d154617e3adbbda1c96287ecde5e3eceac04"
},
"downloads": -1,
"filename": "pyobas-1.17.3.tar.gz",
"has_sig": false,
"md5_digest": "680d692e0c9a510e069242638ae9c344",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38602,
"upload_time": "2025-07-09T07:53:23",
"upload_time_iso_8601": "2025-07-09T07:53:23.822965Z",
"url": "https://files.pythonhosted.org/packages/51/3f/4188e709b08e64d16be62fca72b302c3267c0ef95b9ecea8184108a8c2eb/pyobas-1.17.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 07:53:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenBAS-Platform",
"github_project": "client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [
{
"name": "datefinder",
"specs": [
[
"~=",
"0.7.3"
]
]
},
{
"name": "pika",
"specs": [
[
"~=",
"1.3.0"
]
]
},
{
"name": "python-magic",
"specs": [
[
"~=",
"0.4.27"
]
]
},
{
"name": "python-magic-bin",
"specs": [
[
"~=",
"0.4.14"
]
]
},
{
"name": "python_json_logger",
"specs": [
[
"~=",
"3.3.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"~=",
"2.11.3"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"80.4.0"
]
]
},
{
"name": "cachetools",
"specs": [
[
"~=",
"5.5.0"
]
]
},
{
"name": "prometheus-client",
"specs": [
[
"~=",
"0.21.1"
]
]
},
{
"name": "opentelemetry-api",
"specs": [
[
"~=",
"1.32.0"
]
]
},
{
"name": "opentelemetry-sdk",
"specs": [
[
"~=",
"1.32.0"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"~=",
"1.0.0"
]
]
},
{
"name": "dataclasses-json",
"specs": [
[
"~=",
"0.6.4"
]
]
},
{
"name": "thefuzz",
"specs": [
[
"~=",
"0.22"
]
]
}
],
"lcname": "pyobas"
}
JSON
