| Name | doover JSON |
| Version |
0.4.15
JSON |
| download |
| home_page | None |
| Summary | Python package for interacting with Doover |
| upload_time | 2025-08-20 01:35:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
doover
doover cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyDoover: The Python Package for Doover
PyDoover is a Python package that provides a simple and easy-to-use interface for using the Doover platform on devices, in tasks and CLIs.
## Quick Links
- [Doover Website](https://doover.com)
- [General Documentation](https://docs.doover.com)
- [PyDoover API Reference](https://pydoover.readthedocs.io)
## Installing
**Python 3.11 or higher is required**
```shell
# Using UV
uv add pydoover
# Using pip
pip install -U pydoover
# to install the development version:
pip install -U git+https://github.com/spaneng/pydoover
```
If you are using `pydoover` and need **grpc** support and **are not** using the `doover_device_base` docker image, install the grpc optional dependencies:
We currently use `grpcio==1.65.1` across all our services, so you need to install this version of `grpcio` to avoid issues.
```bash
uv add pydoover[grpc]
# or
pip install -U pydoover[grpc]
```
### Debian Package
The `pydoover` package (in particular CLI) is also available as a Debian package. You can install it using the following command:
```bash
# add the Doover apt repository:
sudo wget http://apt.u.doover.com/install.sh -O - | sh
# install the package
sudo apt install doover-pydoover
```
## Development
To install all dependencies for development, install all optional dependencies (grpc, reports, test, etc.), run:
```bash
uv sync --all-extras --all-groups
```
We use pre-commit hooks to ensure code quality and consistency using Ruff. To set up pre-commit hooks, run the following command:
```bash
pre-commit install
```
To run unit tests, use `pytest` in the main directory of the repository:
```bash
uv run pytest
```
### Documentation
The documentation for PyDoover is generated using Sphinx and can be found in the `docs` directory. To build the documentation, run:
```bash
uv sync --all-extras --all-groups # ensure all dependencies are installed
cd docs
make html
```
## Contributing
For more information, please reach out to the maintainers at hello@doover.com
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "doover",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "doover, doover cli",
"author": null,
"author_email": "Doover Team <developers@doover.com>",
"download_url": "https://files.pythonhosted.org/packages/14/2e/40993471cf5b9486e7eabc779c4f8a6c8e69b184757a8ce24a9e9c0e0a9f/doover-0.4.15.tar.gz",
"platform": null,
"description": "# PyDoover: The Python Package for Doover\n\nPyDoover is a Python package that provides a simple and easy-to-use interface for using the Doover platform on devices, in tasks and CLIs.\n\n## Quick Links\n\n- [Doover Website](https://doover.com)\n- [General Documentation](https://docs.doover.com)\n- [PyDoover API Reference](https://pydoover.readthedocs.io)\n\n## Installing\n**Python 3.11 or higher is required**\n\n```shell\n# Using UV\nuv add pydoover\n\n# Using pip\npip install -U pydoover\n\n# to install the development version:\npip install -U git+https://github.com/spaneng/pydoover\n```\n\nIf you are using `pydoover` and need **grpc** support and **are not** using the `doover_device_base` docker image, install the grpc optional dependencies:\n\nWe currently use `grpcio==1.65.1` across all our services, so you need to install this version of `grpcio` to avoid issues.\n```bash\nuv add pydoover[grpc]\n# or\npip install -U pydoover[grpc]\n```\n\n### Debian Package\nThe `pydoover` package (in particular CLI) is also available as a Debian package. You can install it using the following command:\n\n```bash\n# add the Doover apt repository:\nsudo wget http://apt.u.doover.com/install.sh -O - | sh\n\n# install the package\nsudo apt install doover-pydoover\n```\n\n## Development\n\nTo install all dependencies for development, install all optional dependencies (grpc, reports, test, etc.), run:\n```bash\nuv sync --all-extras --all-groups\n```\n\nWe use pre-commit hooks to ensure code quality and consistency using Ruff. To set up pre-commit hooks, run the following command:\n\n```bash\npre-commit install\n```\n\nTo run unit tests, use `pytest` in the main directory of the repository:\n\n```bash\nuv run pytest\n```\n\n### Documentation\nThe documentation for PyDoover is generated using Sphinx and can be found in the `docs` directory. To build the documentation, run:\n\n```bash\nuv sync --all-extras --all-groups # ensure all dependencies are installed\ncd docs\nmake html\n```\n\n\n## Contributing\n\nFor more information, please reach out to the maintainers at hello@doover.com\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python package for interacting with Doover",
"version": "0.4.15",
"project_urls": {
"Homepage": "https://doover.com"
},
"split_keywords": [
"doover",
" doover cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "16de938a9341ab7e4b8006749ab86aead1c5257b2ff9d98b58a7ac910eaf6544",
"md5": "b3d2d552335952200f43de665f9578d5",
"sha256": "4effa6e76a4d46b764444795da75978215dda1e62c7c3642b3d1e3325480340c"
},
"downloads": -1,
"filename": "doover-0.4.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3d2d552335952200f43de665f9578d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 145515,
"upload_time": "2025-08-20T01:35:01",
"upload_time_iso_8601": "2025-08-20T01:35:01.205008Z",
"url": "https://files.pythonhosted.org/packages/16/de/938a9341ab7e4b8006749ab86aead1c5257b2ff9d98b58a7ac910eaf6544/doover-0.4.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "142e40993471cf5b9486e7eabc779c4f8a6c8e69b184757a8ce24a9e9c0e0a9f",
"md5": "aa082e85a92fded3193f340a54eb6366",
"sha256": "c14c92678d1064b27724aac8058fe3fd01b444a8f28aee4b3f242bd4e0d67f50"
},
"downloads": -1,
"filename": "doover-0.4.15.tar.gz",
"has_sig": false,
"md5_digest": "aa082e85a92fded3193f340a54eb6366",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 202297,
"upload_time": "2025-08-20T01:35:02",
"upload_time_iso_8601": "2025-08-20T01:35:02.550736Z",
"url": "https://files.pythonhosted.org/packages/14/2e/40993471cf5b9486e7eabc779c4f8a6c8e69b184757a8ce24a9e9c0e0a9f/doover-0.4.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 01:35:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "doover"
}
