pydoover

Name	pydoover JSON
Version	0.4.14 JSON
	download
home_page	None
Summary	Python package for interacting with Doover
upload_time	2025-08-15 02:49:24
maintainer	None
docs_url	None
author	None
requires_python	>=3.11
license	None
keywords	doover doover cli pydoover
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": "pydoover",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "doover, doover cli, pydoover",
    "author": null,
    "author_email": "Doover Team <developers@doover.com>",
    "download_url": "https://files.pythonhosted.org/packages/86/48/8dde150c356d3d225310736dfc71d04270fb9102e2e5131f24a9d7f8e556/pydoover-0.4.14.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.14",
    "project_urls": {
        "Homepage": "https://doover.com"
    },
    "split_keywords": [
        "doover",
        " doover cli",
        " pydoover"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "be7482f06b0cc1ae9c2f620bb910ef546ddc97ffef92283a4112b33a42f8a8b6",
                "md5": "6e3794f1ad2f42ffc4f5475338b0a4c7",
                "sha256": "9a2736cc1b777f8670189d9d6928dd33e895193764a71c8eb104c756bc628692"
            },
            "downloads": -1,
            "filename": "pydoover-0.4.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e3794f1ad2f42ffc4f5475338b0a4c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 145804,
            "upload_time": "2025-08-15T02:49:22",
            "upload_time_iso_8601": "2025-08-15T02:49:22.696066Z",
            "url": "https://files.pythonhosted.org/packages/be/74/82f06b0cc1ae9c2f620bb910ef546ddc97ffef92283a4112b33a42f8a8b6/pydoover-0.4.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "86488dde150c356d3d225310736dfc71d04270fb9102e2e5131f24a9d7f8e556",
                "md5": "47eb258c77bbac84729a8d002e0dea91",
                "sha256": "1659261414e72024ad2cf62e528ad059e1cb247bfc8f5bab9eb6930830edb695"
            },
            "downloads": -1,
            "filename": "pydoover-0.4.14.tar.gz",
            "has_sig": false,
            "md5_digest": "47eb258c77bbac84729a8d002e0dea91",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 201327,
            "upload_time": "2025-08-15T02:49:24",
            "upload_time_iso_8601": "2025-08-15T02:49:24.164952Z",
            "url": "https://files.pythonhosted.org/packages/86/48/8dde150c356d3d225310736dfc71d04270fb9102e2e5131f24a9d7f8e556/pydoover-0.4.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-15 02:49:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pydoover"
}