Dog Breeds API
============
Dog Breeds is a simple tool for getting information about dog breeds. It returns information such as breed name, temperament, lifespan, and more.
This is a Python API Wrapper for the [Dog Breeds API](https://apiverve.com/marketplace/api/dogbreeds)
---
## Installation
pip install apiverve-dogbreeds
---
## Configuration
Before using the dogbreeds API client, you have to setup your account and obtain your API Key.
You can get it by signing up at [https://apiverve.com](https://apiverve.com)
---
## Usage
The Dog Breeds API documentation is found here: [https://docs.apiverve.com/api/dogbreeds](https://docs.apiverve.com/api/dogbreeds).
You can find parameters, example responses, and status codes documented here.
### Setup
```
# Import the client module
from apiverve_dogbreeds.apiClient import DogbreedsAPIClient
# Initialize the client with your APIVerve API key
api = DogbreedsAPIClient("[YOUR_API_KEY]")
```
---
### Perform Request
Using the API client, you can perform requests to the API.
###### Define Query
```
query = { "breed": "beagle" }
```
###### Simple Request
```
# Make a request to the API
result = api.execute(query)
# Print the result
print(result)
```
###### Example Response
```
{
"status": "ok",
"error": null,
"data": {
"breed": "beagle",
"foundCount": 1,
"foundBreeds": [
{
"name": "Beagle",
"weight": {
"lowerLbs": 20,
"upperLbs": 35
},
"height": {
"lowerInches": 13,
"upperInches": 15
},
"bredFor": "rabbit, hare hunting",
"group": "hound",
"life_span": {
"lowerYears": 13,
"upperYears": 16
},
"traits": [
"amiable",
"even tempered",
"excitable",
"determined",
"gentle",
"intelligent"
]
}
]
},
"code": 200
}
```
---
## Customer Support
Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
---
## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
---
## Legal
All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
---
## License
Licensed under the The MIT License (MIT)
Copyright (©) 2024 APIVerve, and Evlar LLC
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": "apiverve-dogbreeds",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "dog breeds, dog breeds api, dog breeds tool, dog breeds software, dog breeds service",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/8f/fd1f1e5b9d3e0d8fe1e1a2ada69863e55c1febcc6d0edcb84667817d18d2/apiverve_dogbreeds-1.1.5.tar.gz",
"platform": null,
"description": "Dog Breeds API\r\n============\r\n\r\nDog Breeds is a simple tool for getting information about dog breeds. It returns information such as breed name, temperament, lifespan, and more.\r\n\r\n\r\n\r\n\r\n\r\nThis is a Python API Wrapper for the [Dog Breeds API](https://apiverve.com/marketplace/api/dogbreeds)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-dogbreeds\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the dogbreeds API client, you have to setup your account and obtain your API Key. \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Dog Breeds API documentation is found here: [https://docs.apiverve.com/api/dogbreeds](https://docs.apiverve.com/api/dogbreeds). \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_dogbreeds.apiClient import DogbreedsAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = DogbreedsAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"breed\": \"beagle\" }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n \"status\": \"ok\",\r\n \"error\": null,\r\n \"data\": {\r\n \"breed\": \"beagle\",\r\n \"foundCount\": 1,\r\n \"foundBreeds\": [\r\n {\r\n \"name\": \"Beagle\",\r\n \"weight\": {\r\n \"lowerLbs\": 20,\r\n \"upperLbs\": 35\r\n },\r\n \"height\": {\r\n \"lowerInches\": 13,\r\n \"upperInches\": 15\r\n },\r\n \"bredFor\": \"rabbit, hare hunting\",\r\n \"group\": \"hound\",\r\n \"life_span\": {\r\n \"lowerYears\": 13,\r\n \"upperYears\": 16\r\n },\r\n \"traits\": [\r\n \"amiable\",\r\n \"even tempered\",\r\n \"excitable\",\r\n \"determined\",\r\n \"gentle\",\r\n \"intelligent\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission 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:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE 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.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Dog Breeds is a simple tool for getting information about dog breeds. It returns information such as breed name, temperament, lifespan, and more.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/dogbreeds?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/dogbreeds.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"dog breeds",
" dog breeds api",
" dog breeds tool",
" dog breeds software",
" dog breeds service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a64d013246b4903617a130b54c5141d1e14ad6522d5d2af846e268dfad20e4bc",
"md5": "7430eeb17144408fc7e536ad6589687d",
"sha256": "8ac3026b850a3b7c684246cc609108bd12d5c6c22cdea121b7b6c9fb9b0ab39b"
},
"downloads": -1,
"filename": "apiverve_dogbreeds-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7430eeb17144408fc7e536ad6589687d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7335,
"upload_time": "2024-09-21T06:42:46",
"upload_time_iso_8601": "2024-09-21T06:42:46.578026Z",
"url": "https://files.pythonhosted.org/packages/a6/4d/013246b4903617a130b54c5141d1e14ad6522d5d2af846e268dfad20e4bc/apiverve_dogbreeds-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a58ffd1f1e5b9d3e0d8fe1e1a2ada69863e55c1febcc6d0edcb84667817d18d2",
"md5": "7699b607927f2e53d5ccdb57747d065c",
"sha256": "1d65685310737d6cf0540fd44e158f343e473c7a349a599d604c210917c436e7"
},
"downloads": -1,
"filename": "apiverve_dogbreeds-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7699b607927f2e53d5ccdb57747d065c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 7205,
"upload_time": "2024-09-21T06:42:47",
"upload_time_iso_8601": "2024-09-21T06:42:47.789647Z",
"url": "https://files.pythonhosted.org/packages/a5/8f/fd1f1e5b9d3e0d8fe1e1a2ada69863e55c1febcc6d0edcb84667817d18d2/apiverve_dogbreeds-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 06:42:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "dogbreeds.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-dogbreeds"
}
JSON
