| Name | spark-roomba JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to control Roomba |
| upload_time | 2024-07-04 10:07:59 |
| maintainer | None |
| docs_url | None |
| author | Maki |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://huggingface.co/datasets/MakiAi/IconAssets/resolve/main/SPARK.jpg" width="100%">
<br>
<h1 align="center">S.P.A.R.K</h1>
<h2 align="center">
～ Smart Programmable Agent for Roomba with Knowledge ～
<br>
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/spark-roomba">
<img alt="PyPI - Format" src="https://img.shields.io/pypi/format/spark-roomba">
<img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/spark-roomba">
<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/spark-roomba">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dd/spark-roomba">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/spark-roomba">
<a href="https://github.com/Sunwood-ai-labs/SPARK" title="Go to GitHub repo"><img src="https://img.shields.io/static/v1?label=SPARK&message=Sunwood-ai-labs&color=blue&logo=github"></a>
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Sunwood-ai-labs/SPARK">
<a href="https://github.com/Sunwood-ai-labs/SPARK"><img alt="forks - Sunwood-ai-labs" src="https://img.shields.io/github/forks/SPARK/Sunwood-ai-labs?style=social"></a>
<a href="https://github.com/Sunwood-ai-labs/SPARK"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/Sunwood-ai-labs/SPARK"></a>
<a href="https://github.com/Sunwood-ai-labs/SPARK"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/Sunwood-ai-labs/SPARK"></a>
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/Sunwood-ai-labs/SPARK?color=red">
<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/Sunwood-ai-labs/SPARK?sort=semver&color=orange">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/SPARK/publish-to-pypi.yml">
<br>
<p align="center">
<a href="https://hamaruki.com/"><b>[🌐 Website]</b></a> •
<a href="https://github.com/Sunwood-ai-labs"><b>[🐱 GitHub]</b></a>
<a href="https://x.com/hAru_mAki_ch"><b>[🐦 Twitter]</b></a> •
<a href="https://hamaruki.com/"><b>[🍀 Official Blog]</b></a>
</p>
</h2>
</p>
>[!IMPORTANT]
>このリポジトリのリリースノートやREADME、コミットメッセージの9割近くは[claude.ai](https://claude.ai/)や[ChatGPT4](https://chatgpt.com/)を活用した[AIRA](https://github.com/Sunwood-ai-labs/AIRA), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), [Gaiah](https://github.com/Sunwood-ai-labs/Gaiah), [HarmonAI_II](https://github.com/Sunwood-ai-labs/HarmonAI_II)で生成しています。
## プロジェクト概要
SPARK (Smart Programmable Agent for Roomba with Knowledge) は、Roombaロボット掃除機を制御するためのPythonベースのCLIツールです。このプロジェクトは、Roombaの遠隔操作や自動化を可能にし、より柔軟な清掃プロセスの実現を目指しています。
## 機能
- Roombaの速度と角速度の制御
- コマンドラインインターフェース（CLI）を通じた操作
- ロギング機能によるデバッグと操作履歴の記録
## インストール
SPARKは、Poetry を使用して依存関係を管理しています。以下の手順でインストールできます：
```bash
pip install spark-roomba
```
## 使用方法
SPARKは、コマンドラインから以下のように使用できます：
```bash
spark-roomba drive <speed> <deg>
```
- `<speed>`: Roombaの速度（cm/s）
- `<deg>`: Roombaの角速度（deg/s）
例：
```bash
spark-roomba drive 20 45
```
この例では、Roombaを20 cm/sの速度で前進させ、同時に45 deg/sの角速度で回転させます。
## 開発環境のセットアップ
1. リポジトリをクローンします：
```
git clone https://github.com/Sunwood-ai-labs/SPARK.git
cd SPARK
```
2. Poetry をインストールします（まだの場合）：
```
curl -sSL https://install.python-poetry.org | python3 -
```
3. プロジェクトの依存関係をインストールします：
```
poetry install
```
4. 開発用の仮想環境を有効化します：
```
poetry shell
```
## Docker を使用した開発
プロジェクトには Docker と docker-compose の設定が含まれています。以下のコマンドで開発環境を起動できます：
```bash
docker-compose up -d
```
これにより、Pythonと必要な依存関係がインストールされたコンテナが起動します。
## ライセンス
このプロジェクトは MIT ライセンスの下で公開されています。詳細は [LICENSE](LICENSE) ファイルをご覧ください。
## 貢献
プロジェクトへの貢献を歓迎します。バグ報告、機能リクエスト、プルリクエストなど、あらゆる形での貢献をお待ちしています。
## リンク
- [GitHub リポジトリ](https://github.com/Sunwood-ai-labs/SPARK)
- [PyPI パッケージ](https://pypi.org/project/spark-roomba/)
- [バグトラッカー](https://github.com/Sunwood-ai-labs/SPARK/issues)
Raw data
{
"_id": null,
"home_page": null,
"name": "spark-roomba",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Maki",
"author_email": "sunwood.ai.labs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/81/b3/53db10bf47c984c33e9af2e6c24a2b7ce9ccc1c74873cd3de126e6c2d38d/spark_roomba-0.1.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://huggingface.co/datasets/MakiAi/IconAssets/resolve/main/SPARK.jpg\" width=\"100%\">\n<br>\n<h1 align=\"center\">S.P.A.R.K</h1>\n<h2 align=\"center\">\n \uff5e Smart Programmable Agent for Roomba with Knowledge \uff5e\n<br>\n <img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/spark-roomba\">\n<img alt=\"PyPI - Format\" src=\"https://img.shields.io/pypi/format/spark-roomba\">\n<img alt=\"PyPI - Implementation\" src=\"https://img.shields.io/pypi/implementation/spark-roomba\">\n<img alt=\"PyPI - Status\" src=\"https://img.shields.io/pypi/status/spark-roomba\">\n<img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dd/spark-roomba\">\n<img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dw/spark-roomba\">\n<a href=\"https://github.com/Sunwood-ai-labs/SPARK\" title=\"Go to GitHub repo\"><img src=\"https://img.shields.io/static/v1?label=SPARK&message=Sunwood-ai-labs&color=blue&logo=github\"></a>\n<img alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/Sunwood-ai-labs/SPARK\">\n<a href=\"https://github.com/Sunwood-ai-labs/SPARK\"><img alt=\"forks - Sunwood-ai-labs\" src=\"https://img.shields.io/github/forks/SPARK/Sunwood-ai-labs?style=social\"></a>\n<a href=\"https://github.com/Sunwood-ai-labs/SPARK\"><img alt=\"GitHub Last Commit\" src=\"https://img.shields.io/github/last-commit/Sunwood-ai-labs/SPARK\"></a>\n<a href=\"https://github.com/Sunwood-ai-labs/SPARK\"><img alt=\"GitHub Top Language\" src=\"https://img.shields.io/github/languages/top/Sunwood-ai-labs/SPARK\"></a>\n<img alt=\"GitHub Release\" src=\"https://img.shields.io/github/v/release/Sunwood-ai-labs/SPARK?color=red\">\n<img alt=\"GitHub Tag\" src=\"https://img.shields.io/github/v/tag/Sunwood-ai-labs/SPARK?sort=semver&color=orange\">\n<img alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/SPARK/publish-to-pypi.yml\">\n<br>\n<p align=\"center\">\n <a href=\"https://hamaruki.com/\"><b>[\ud83c\udf10 Website]</b></a> \u2022\n <a href=\"https://github.com/Sunwood-ai-labs\"><b>[\ud83d\udc31 GitHub]</b></a>\n <a href=\"https://x.com/hAru_mAki_ch\"><b>[\ud83d\udc26 Twitter]</b></a> \u2022\n <a href=\"https://hamaruki.com/\"><b>[\ud83c\udf40 Official Blog]</b></a>\n</p>\n\n</h2>\n\n</p>\n\n>[!IMPORTANT]\n>\u3053\u306e\u30ea\u30dd\u30b8\u30c8\u30ea\u306e\u30ea\u30ea\u30fc\u30b9\u30ce\u30fc\u30c8\u3084README\u3001\u30b3\u30df\u30c3\u30c8\u30e1\u30c3\u30bb\u30fc\u30b8\u306e9\u5272\u8fd1\u304f\u306f[claude.ai](https://claude.ai/)\u3084[ChatGPT4](https://chatgpt.com/)\u3092\u6d3b\u7528\u3057\u305f[AIRA](https://github.com/Sunwood-ai-labs/AIRA), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), [Gaiah](https://github.com/Sunwood-ai-labs/Gaiah), [HarmonAI_II](https://github.com/Sunwood-ai-labs/HarmonAI_II)\u3067\u751f\u6210\u3057\u3066\u3044\u307e\u3059\u3002\n\n## \u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u6982\u8981\n\nSPARK (Smart Programmable Agent for Roomba with Knowledge) \u306f\u3001Roomba\u30ed\u30dc\u30c3\u30c8\u6383\u9664\u6a5f\u3092\u5236\u5fa1\u3059\u308b\u305f\u3081\u306ePython\u30d9\u30fc\u30b9\u306eCLI\u30c4\u30fc\u30eb\u3067\u3059\u3002\u3053\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306f\u3001Roomba\u306e\u9060\u9694\u64cd\u4f5c\u3084\u81ea\u52d5\u5316\u3092\u53ef\u80fd\u306b\u3057\u3001\u3088\u308a\u67d4\u8edf\u306a\u6e05\u6383\u30d7\u30ed\u30bb\u30b9\u306e\u5b9f\u73fe\u3092\u76ee\u6307\u3057\u3066\u3044\u307e\u3059\u3002\n\n## \u6a5f\u80fd\n\n- Roomba\u306e\u901f\u5ea6\u3068\u89d2\u901f\u5ea6\u306e\u5236\u5fa1\n- \u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3\u30a4\u30f3\u30bf\u30fc\u30d5\u30a7\u30fc\u30b9\uff08CLI\uff09\u3092\u901a\u3058\u305f\u64cd\u4f5c\n- \u30ed\u30ae\u30f3\u30b0\u6a5f\u80fd\u306b\u3088\u308b\u30c7\u30d0\u30c3\u30b0\u3068\u64cd\u4f5c\u5c65\u6b74\u306e\u8a18\u9332\n\n## \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\n\nSPARK\u306f\u3001Poetry \u3092\u4f7f\u7528\u3057\u3066\u4f9d\u5b58\u95a2\u4fc2\u3092\u7ba1\u7406\u3057\u3066\u3044\u307e\u3059\u3002\u4ee5\u4e0b\u306e\u624b\u9806\u3067\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3067\u304d\u307e\u3059\uff1a\n\n```bash\npip install spark-roomba\n```\n\n## \u4f7f\u7528\u65b9\u6cd5\n\nSPARK\u306f\u3001\u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3\u304b\u3089\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u4f7f\u7528\u3067\u304d\u307e\u3059\uff1a\n\n```bash\nspark-roomba drive <speed> <deg>\n```\n\n- `<speed>`: Roomba\u306e\u901f\u5ea6\uff08cm/s\uff09\n- `<deg>`: Roomba\u306e\u89d2\u901f\u5ea6\uff08deg/s\uff09\n\n\u4f8b\uff1a\n```bash\nspark-roomba drive 20 45\n```\n\n\u3053\u306e\u4f8b\u3067\u306f\u3001Roomba\u309220 cm/s\u306e\u901f\u5ea6\u3067\u524d\u9032\u3055\u305b\u3001\u540c\u6642\u306b45 deg/s\u306e\u89d2\u901f\u5ea6\u3067\u56de\u8ee2\u3055\u305b\u307e\u3059\u3002\n\n## \u958b\u767a\u74b0\u5883\u306e\u30bb\u30c3\u30c8\u30a2\u30c3\u30d7\n\n1. \u30ea\u30dd\u30b8\u30c8\u30ea\u3092\u30af\u30ed\u30fc\u30f3\u3057\u307e\u3059\uff1a\n ```\n git clone https://github.com/Sunwood-ai-labs/SPARK.git\n cd SPARK\n ```\n\n2. Poetry \u3092\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3057\u307e\u3059\uff08\u307e\u3060\u306e\u5834\u5408\uff09\uff1a\n ```\n curl -sSL https://install.python-poetry.org | python3 -\n ```\n\n3. \u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306e\u4f9d\u5b58\u95a2\u4fc2\u3092\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3057\u307e\u3059\uff1a\n ```\n poetry install\n ```\n\n4. \u958b\u767a\u7528\u306e\u4eee\u60f3\u74b0\u5883\u3092\u6709\u52b9\u5316\u3057\u307e\u3059\uff1a\n ```\n poetry shell\n ```\n\n## Docker \u3092\u4f7f\u7528\u3057\u305f\u958b\u767a\n\n\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306b\u306f Docker \u3068 docker-compose \u306e\u8a2d\u5b9a\u304c\u542b\u307e\u308c\u3066\u3044\u307e\u3059\u3002\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3067\u958b\u767a\u74b0\u5883\u3092\u8d77\u52d5\u3067\u304d\u307e\u3059\uff1a\n\n```bash\ndocker-compose up -d\n```\n\n\u3053\u308c\u306b\u3088\u308a\u3001Python\u3068\u5fc5\u8981\u306a\u4f9d\u5b58\u95a2\u4fc2\u304c\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3055\u308c\u305f\u30b3\u30f3\u30c6\u30ca\u304c\u8d77\u52d5\u3057\u307e\u3059\u3002\n\n## \u30e9\u30a4\u30bb\u30f3\u30b9\n\n\u3053\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306f MIT \u30e9\u30a4\u30bb\u30f3\u30b9\u306e\u4e0b\u3067\u516c\u958b\u3055\u308c\u3066\u3044\u307e\u3059\u3002\u8a73\u7d30\u306f [LICENSE](LICENSE) \u30d5\u30a1\u30a4\u30eb\u3092\u3054\u89a7\u304f\u3060\u3055\u3044\u3002\n\n## \u8ca2\u732e\n\n\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3078\u306e\u8ca2\u732e\u3092\u6b53\u8fce\u3057\u307e\u3059\u3002\u30d0\u30b0\u5831\u544a\u3001\u6a5f\u80fd\u30ea\u30af\u30a8\u30b9\u30c8\u3001\u30d7\u30eb\u30ea\u30af\u30a8\u30b9\u30c8\u306a\u3069\u3001\u3042\u3089\u3086\u308b\u5f62\u3067\u306e\u8ca2\u732e\u3092\u304a\u5f85\u3061\u3057\u3066\u3044\u307e\u3059\u3002\n\n## \u30ea\u30f3\u30af\n\n- [GitHub \u30ea\u30dd\u30b8\u30c8\u30ea](https://github.com/Sunwood-ai-labs/SPARK)\n- [PyPI \u30d1\u30c3\u30b1\u30fc\u30b8](https://pypi.org/project/spark-roomba/)\n- [\u30d0\u30b0\u30c8\u30e9\u30c3\u30ab\u30fc](https://github.com/Sunwood-ai-labs/SPARK/issues)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool to control Roomba",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/Sunwood-ai-labs/SPARK/issues",
"Homepage": "https://github.com/Sunwood-ai-labs/SPARK"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c2a12168c70f8565e30060c9a66c7bdfb19b2e1f07ab20e8bcb2eaadfe16637d",
"md5": "44d0dec0924cbc77b53181d639134cfb",
"sha256": "7b03dd26f29c8979bb7ea883054cfc617d50a31ee5f61ff4a83192d5551053c3"
},
"downloads": -1,
"filename": "spark_roomba-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44d0dec0924cbc77b53181d639134cfb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 20174,
"upload_time": "2024-07-04T10:07:58",
"upload_time_iso_8601": "2024-07-04T10:07:58.255747Z",
"url": "https://files.pythonhosted.org/packages/c2/a1/2168c70f8565e30060c9a66c7bdfb19b2e1f07ab20e8bcb2eaadfe16637d/spark_roomba-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81b353db10bf47c984c33e9af2e6c24a2b7ce9ccc1c74873cd3de126e6c2d38d",
"md5": "62ef5bcfeeb4a1a8b45d2360f2b51d87",
"sha256": "eed3994ba36c6f55eeb9ee1397c54a618cfa3621631e2724db11efcb26e74a19"
},
"downloads": -1,
"filename": "spark_roomba-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "62ef5bcfeeb4a1a8b45d2360f2b51d87",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 21479,
"upload_time": "2024-07-04T10:07:59",
"upload_time_iso_8601": "2024-07-04T10:07:59.809200Z",
"url": "https://files.pythonhosted.org/packages/81/b3/53db10bf47c984c33e9af2e6c24a2b7ce9ccc1c74873cd3de126e6c2d38d/spark_roomba-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 10:07:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sunwood-ai-labs",
"github_project": "SPARK",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spark-roomba"
}
