| Name | pyAdguard JSON |
| Version |
0.2.2.post0
JSON |
| download |
| home_page | None |
| Summary | Python Wrapper for the Adguard Home API |
| upload_time | 2025-01-21 10:05:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2025 Lars Jelschen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
adguard home
adguard
api
wrapper
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python: AdGuard Home API Client
PyAdguard is an API wrapper inspired by the repository Proxmoxer:
https://github.com/proxmoxer/proxmoxer/tree/develop
## About
A simple alternative API to interact with AdGuard Home.
Using the given AdGuardHome API description to get the needed URL paths:
https://github.com/AdguardTeam/AdGuardHome/blob/master/openapi/openapi.yaml
## Installation
Normal installation:
```bash
pip install pyadguard
```
Local installation:
```bash
git clone https://github.com/ljelschen/pyadguard.git
cd pyadguard
pip install .
```
## Usage
Modify the given `sample.env` and rename the file to `.env`
```py
# %% imports
from pyadguard import AdguardAPI
from dotenv import dotenv_values
config = dotenv_values(".env")
# %% create an instance of AdguardAPI
adguard = AdguardAPI(
host=config["ADGUARD_HOST"],
username=config["ADGUARD_USERNAME"],
password=config["ADGUARD_PASSWORD"],
backend="https"
)
# %% read the stats of the AdGuard Home instance
# the url is /stats
stats = adguard.stats.get()
print(stats)
```
More examples are included in the examples folder.
## Changelog & Releases
Details of changes and releases will be documented here.
## Contributing
Guidelines for contributing will be provided here.
## Setting Up the Development Environment
Instructions for setting up the development environment will be provided here.
## Authors & Contributors
The original setup of this repository is by Lars Jelschen.
## License
MIT License
Copyright (c) 2025 Lars Jelschen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyAdguard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Lars Jelschen <mail@lars-jelschen.de>",
"keywords": "adguard home, adguard, api, wrapper, client",
"author": null,
"author_email": "Lars Jelschen <mail@lars-jelschen.de>",
"download_url": "https://files.pythonhosted.org/packages/17/d6/bfaecc2ced9c223880a212ab9c5ce5a7d2e0e6075f071d010f6502f1771f/pyadguard-0.2.2.post0.tar.gz",
"platform": null,
"description": "# Python: AdGuard Home API Client\r\n\r\nPyAdguard is an API wrapper inspired by the repository Proxmoxer: \r\nhttps://github.com/proxmoxer/proxmoxer/tree/develop\r\n\r\n## About\r\n\r\nA simple alternative API to interact with AdGuard Home. \r\nUsing the given AdGuardHome API description to get the needed URL paths: \r\nhttps://github.com/AdguardTeam/AdGuardHome/blob/master/openapi/openapi.yaml\r\n\r\n## Installation\r\n\r\n\r\nNormal installation:\r\n```bash\r\npip install pyadguard\r\n```\r\n\r\nLocal installation:\r\n```bash\r\ngit clone https://github.com/ljelschen/pyadguard.git\r\ncd pyadguard\r\npip install .\r\n```\r\n\r\n## Usage\r\nModify the given `sample.env` and rename the file to `.env`\r\n\r\n```py\r\n# %% imports\r\nfrom pyadguard import AdguardAPI\r\nfrom dotenv import dotenv_values\r\n\r\nconfig = dotenv_values(\".env\")\r\n\r\n# %% create an instance of AdguardAPI\r\nadguard = AdguardAPI(\r\n host=config[\"ADGUARD_HOST\"],\r\n username=config[\"ADGUARD_USERNAME\"],\r\n password=config[\"ADGUARD_PASSWORD\"],\r\n backend=\"https\"\r\n)\r\n# %% read the stats of the AdGuard Home instance\r\n\r\n# the url is /stats\r\nstats = adguard.stats.get()\r\nprint(stats)\r\n```\r\n\r\nMore examples are included in the examples folder.\r\n\r\n## Changelog & Releases\r\n\r\nDetails of changes and releases will be documented here.\r\n\r\n## Contributing\r\n\r\nGuidelines for contributing will be provided here.\r\n\r\n## Setting Up the Development Environment\r\n\r\nInstructions for setting up the development environment will be provided here.\r\n\r\n## Authors & Contributors\r\n\r\nThe original setup of this repository is by Lars Jelschen.\r\n\r\n## License\r\n\r\nMIT License \r\n\r\nCopyright (c) 2025 Lars Jelschen\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy\r\nof this software and associated documentation files (the \"Software\"), to deal\r\nin the Software without restriction, including without limitation the rights\r\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\ncopies of the Software, and to permit persons to whom the Software is\r\nfurnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Lars Jelschen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python Wrapper for the Adguard Home API",
"version": "0.2.2.post0",
"project_urls": {
"documentation": "https://github.com/ljelschen/pyadguard",
"homepage": "https://github.com/ljelschen/pyadguard",
"repository": "https://github.com/ljelschen/pyadguard"
},
"split_keywords": [
"adguard home",
" adguard",
" api",
" wrapper",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3939db9fb75c7d4f6304e37b2e8427751a68f0e83e030c460a5f68b60568a663",
"md5": "3fe8798bd85db0da743148e2f89bbd1c",
"sha256": "43a2712e679dff39998a83a8378a882eb453268bc17c2440b8e3a5bd0c798af4"
},
"downloads": -1,
"filename": "pyAdguard-0.2.2.post0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fe8798bd85db0da743148e2f89bbd1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6300,
"upload_time": "2025-01-21T10:05:01",
"upload_time_iso_8601": "2025-01-21T10:05:01.951137Z",
"url": "https://files.pythonhosted.org/packages/39/39/db9fb75c7d4f6304e37b2e8427751a68f0e83e030c460a5f68b60568a663/pyAdguard-0.2.2.post0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17d6bfaecc2ced9c223880a212ab9c5ce5a7d2e0e6075f071d010f6502f1771f",
"md5": "32f09f14ee18fbe474a25902c7885438",
"sha256": "7612645c67a2d6b68bb4f6c0f93055b5b0c09d48de0aa29c4e2aeba2baadf946"
},
"downloads": -1,
"filename": "pyadguard-0.2.2.post0.tar.gz",
"has_sig": false,
"md5_digest": "32f09f14ee18fbe474a25902c7885438",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8914,
"upload_time": "2025-01-21T10:05:03",
"upload_time_iso_8601": "2025-01-21T10:05:03.716573Z",
"url": "https://files.pythonhosted.org/packages/17/d6/bfaecc2ced9c223880a212ab9c5ce5a7d2e0e6075f071d010f6502f1771f/pyadguard-0.2.2.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 10:05:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ljelschen",
"github_project": "pyadguard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyadguard"
}
