# BBClient
BBClient provides command interface for bitbake server.
<!--
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]
-->
The typical use case is as follows. You can do it via shell or python easily.
* Get recipe variable value
* Get layer info
* Get image recipes
* Get all the packages
* Start a task of packages
For example, see below.
*Please note that before using bbclient in shell, you have to initialize env by oe-init-build-env*.
```bash
# Please note that before using bbclient in shell, you have to initialize env by oe-init-build-env.
$ source oe-init-build-env
$ bbclient find_best_provider gcc
[null, null, null, "/PATH/TO/POKY/meta/recipes-devtools/gcc/gcc_12.1.bb"]
```
You can do the same with python.
```python
# get recipe file path for specified package
ret: List[str] = client.find_best_provider("gcc")
target_recipe_file_path: str = ret[3]
# parse the recipe file
data_store_index: int = client.parse_recipe_file(target_recipe_file_path)
# get variable in the recipe file
ret: Any = client.data_store_connector_cmd(data_store_index, "getVar", "PN")
```
## System Requirements
* python: 3.7 or later
* yocto: dunfell or kirkstone or main
Please note that this command(and also bitbake) doesn't support dunfell with python3.10.
This is because `collections.Iterable` has not been removed, so dunfell with python3.10 will cause exception.
## Installation
```
pip3 install bbclient
```
<!--
Linux:
```sh
npm install my-crazy-module --save
```
-->
## Document
> **Note**
> For using with shell, we have not documented yet. Please see `$bbclient --help`.
* [specification](https://angrymane.github.io/bbclient/bbclient.html)
* [use case](https://angrymane.github.io/bbclient/usecase.html)
<!--
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
```sh
make install
npm test
```
-->
Raw data
{
"_id": null,
"home_page": "https://github.com/AngryMane/bbclient",
"name": "bbclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "yocto,bitbake",
"author": "AngryMane",
"author_email": "regulationdango@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8b/d6/8a83736f47fbb21f94821cc5c77b2045b35f9338f42558e29f2fee8d70e0/bbclient-0.8.0.tar.gz",
"platform": null,
"description": "# BBClient\nBBClient provides command interface for bitbake server. \n\n<!--\n[![NPM Version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Downloads Stats][npm-downloads]][npm-url]\n-->\n\nThe typical use case is as follows. You can do it via shell or python easily. \n\n* Get recipe variable value\n* Get layer info\n* Get image recipes\n* Get all the packages\n* Start a task of packages\n\nFor example, see below. \n*Please note that before using bbclient in shell, you have to initialize env by oe-init-build-env*. \n\n```bash\n# Please note that before using bbclient in shell, you have to initialize env by oe-init-build-env.\n$ source oe-init-build-env\n$ bbclient find_best_provider gcc\n[null, null, null, \"/PATH/TO/POKY/meta/recipes-devtools/gcc/gcc_12.1.bb\"]\n```\n\nYou can do the same with python. \n\n```python\n# get recipe file path for specified package\nret: List[str] = client.find_best_provider(\"gcc\")\ntarget_recipe_file_path: str = ret[3]\n\n# parse the recipe file\ndata_store_index: int = client.parse_recipe_file(target_recipe_file_path)\n\n# get variable in the recipe file\nret: Any = client.data_store_connector_cmd(data_store_index, \"getVar\", \"PN\")\n```\n\n## System Requirements\n* python: 3.7 or later\n* yocto: dunfell or kirkstone or main\n\nPlease note that this command(and also bitbake) doesn't support dunfell with python3.10. \nThis is because `collections.Iterable` has not been removed, so dunfell with python3.10 will cause exception.\n\n## Installation\n\n```\npip3 install bbclient\n```\n\n<!--\nLinux:\n\n```sh\nnpm install my-crazy-module --save\n```\n-->\n\n## Document\n\n> **Note**\n> For using with shell, we have not documented yet. Please see `$bbclient --help`. \n\n* [specification](https://angrymane.github.io/bbclient/bbclient.html) \n* [use case](https://angrymane.github.io/bbclient/usecase.html) \n\n\n<!--\nDescribe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.\n\n```sh\nmake install\nnpm test\n```\n-->\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "bbclient provides utility commands for bitbake.",
"version": "0.8.0",
"split_keywords": [
"yocto",
"bitbake"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edfcf533af2b7e30ee191eac0abc8cf7b9c0218b949e47cfcc271dfcfaaaf796",
"md5": "1c7b59995fccd7941e4f89aaab017bf7",
"sha256": "b51084e218b62fb61c23527265dabeb0b553ed1e91e6afabba659113eabfd12b"
},
"downloads": -1,
"filename": "bbclient-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c7b59995fccd7941e4f89aaab017bf7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 47596,
"upload_time": "2023-02-04T05:12:58",
"upload_time_iso_8601": "2023-02-04T05:12:58.774395Z",
"url": "https://files.pythonhosted.org/packages/ed/fc/f533af2b7e30ee191eac0abc8cf7b9c0218b949e47cfcc271dfcfaaaf796/bbclient-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8bd68a83736f47fbb21f94821cc5c77b2045b35f9338f42558e29f2fee8d70e0",
"md5": "55e21c0b7ea3c0f6b8d154189fc5b0c9",
"sha256": "0c441749003ae59cb40b22f8979556ce429528c5fc358c65acb6c9eb387eb758"
},
"downloads": -1,
"filename": "bbclient-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "55e21c0b7ea3c0f6b8d154189fc5b0c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 29753,
"upload_time": "2023-02-04T05:13:01",
"upload_time_iso_8601": "2023-02-04T05:13:01.132159Z",
"url": "https://files.pythonhosted.org/packages/8b/d6/8a83736f47fbb21f94821cc5c77b2045b35f9338f42558e29f2fee8d70e0/bbclient-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-04 05:13:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AngryMane",
"github_project": "bbclient",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "bbclient"
}
JSON
