# nokey - Access APIs without a Key
nokey is a Python package designed to provide easy access to various APIs that do not require an API key for authentication. This project aims to simplify the process of interacting with different APIs by offering a unified interface for accessing them, all within a single Python package.
## Features
- Access a growing collection of keyless APIs conveniently from one place.
- Organized into submodules based on categories such as country information, finance, geolocation, spaceflight, education, food, random data, jokes, animals, science, and weather, developer tools, language, and games.
- Easily installable via pip, making it accessible to all Python developers.
## Installation
You can install the module using pip:
```
pip install nokey
```
## Usage
Here is a simple example of how to use one of the APIs to access a random dog image:
```python
from nokey.animals import dog_api
# Initialize the DogAPI object
dog = dog_api.DogAPI()
# Get a random dog image URL
dog_image_url = dog.get_random_dog_image()
# Print the URL
print(dog_image_url)
```
Also, to print out a list of the APIs supported by nokey, simply run the following script:
```python
from nokey.helperFuncs.get_api_list import get_api_list
api_list = get_api_list()
print(api_list)
```
Each API class has optional caching with requests_cache. To enable caching, set the use_caching argument when calling the class to True.
Each API class has an "about" attribute that returns a short description of the API. To get the URL for the API documentation of any API, simply call the get_docs_url() method for the API class.
## Contributing
We welcome contributions to expand the range of APIs available in nokey. Whether you want to add a new submodule or enhance an existing one, your contributions are valuable. To contribute, please fork the repository, make your changes, and submit a pull request.
# Supported APIs
## country_info
RestCountries
## finance_and_crypto
Wallstreet Bets
Exchange API
Coinmap
## geolocation
IP API
Zippopotomus
## spaceflight
Spaceflight News
## education
University Domains and Names
## food
Fruityvice
## random
RandomUserGenerator
## jokes
JokeAPI
## animals
DogAPI
## science_and_nature
Nobel Prize API
Integrated Taxonomic Information System
## weather
National Weather Service API
## developer_tools
URL Shortener
URLHaus
APIsGuru
Microlink
FilterLists
## inspiration
Dictum
## language
Free Dictionary
## games
Free To Game
Open Trivia Database
Shadify
## activities
Bored API
## calendar
Nager.Date
## government
Federal Register
USA Spending
## tv_and_film
Star Trek API
## books_and_literature
Gutendex
## art_and_images
Lorum Picsum
Art Institute of Chicago
## health
Open Disease
# Future Roadmap
As the project grows, we envision expanding the collection of keyless APIs to cover a wide range of categories. Your feedback and contributions will play a crucial role in shaping the future of nokey.
# License
This project is licensed under the MIT License - see the LICENSE file for details.
# Documentation
Check out the [docs](https://nokey.readthedocs.io/en/latest/).
# Disclaimer:
Be sure to read the API documentation if you plan to use any of the APIs for development. This package is for accessing keyless, free, open source APIs and I am not responsible for the content of the APIs themselves.
Raw data
{
"_id": null,
"home_page": "https://github.com/SpyderRex/nokey",
"name": "nokey",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "API, requests, xmltodict",
"author": "Spyder Rex",
"author_email": "billyjohnsonauthor@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5f/b9/aaed2699c49702bb14f3a82c9b7e46966e9bdc7a1a873aca931bec06b585/nokey-0.7.4.tar.gz",
"platform": null,
"description": "# nokey - Access APIs without a Key\n\nnokey is a Python package designed to provide easy access to various APIs that do not require an API key for authentication. This project aims to simplify the process of interacting with different APIs by offering a unified interface for accessing them, all within a single Python package.\n\n## Features\n\n- Access a growing collection of keyless APIs conveniently from one place.\n- Organized into submodules based on categories such as country information, finance, geolocation, spaceflight, education, food, random data, jokes, animals, science, and weather, developer tools, language, and games.\n- Easily installable via pip, making it accessible to all Python developers.\n\n## Installation\n\nYou can install the module using pip:\n\n```\npip install nokey\n```\n\n## Usage\n\nHere is a simple example of how to use one of the APIs to access a random dog image:\n\n```python\nfrom nokey.animals import dog_api\n\n# Initialize the DogAPI object\ndog = dog_api.DogAPI()\n\n# Get a random dog image URL\ndog_image_url = dog.get_random_dog_image()\n\n# Print the URL\nprint(dog_image_url)\n```\n\nAlso, to print out a list of the APIs supported by nokey, simply run the following script:\n\n```python\nfrom nokey.helperFuncs.get_api_list import get_api_list\n\napi_list = get_api_list()\n\nprint(api_list)\n```\n\nEach API class has optional caching with requests_cache. To enable caching, set the use_caching argument when calling the class to True.\n\nEach API class has an \"about\" attribute that returns a short description of the API. To get the URL for the API documentation of any API, simply call the get_docs_url() method for the API class.\n\n## Contributing\nWe welcome contributions to expand the range of APIs available in nokey. Whether you want to add a new submodule or enhance an existing one, your contributions are valuable. To contribute, please fork the repository, make your changes, and submit a pull request.\n\n# Supported APIs\n## country_info\nRestCountries\n\n## finance_and_crypto\nWallstreet Bets\n\nExchange API\n\nCoinmap\n\n## geolocation\nIP API\n\nZippopotomus\n\n## spaceflight\nSpaceflight News\n\n## education\nUniversity Domains and Names\n\n## food\nFruityvice\n\n## random\nRandomUserGenerator\n\n## jokes\nJokeAPI\n\n## animals\nDogAPI\n\n## science_and_nature\nNobel Prize API\n\nIntegrated Taxonomic Information System\n\n## weather\nNational Weather Service API\n\n## developer_tools\nURL Shortener\n\nURLHaus\n\nAPIsGuru\n\nMicrolink\n\nFilterLists\n\n## inspiration\nDictum\n\n## language\nFree Dictionary\n\n## games\nFree To Game\n\nOpen Trivia Database\n\nShadify\n\n## activities\nBored API\n\n## calendar\nNager.Date\n\n## government\nFederal Register\n\nUSA Spending\n\n## tv_and_film\nStar Trek API\n\n## books_and_literature\nGutendex\n\n## art_and_images\nLorum Picsum\n\nArt Institute of Chicago\n\n## health\nOpen Disease\n\n# Future Roadmap\nAs the project grows, we envision expanding the collection of keyless APIs to cover a wide range of categories. Your feedback and contributions will play a crucial role in shaping the future of nokey.\n\n# License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n# Documentation\nCheck out the [docs](https://nokey.readthedocs.io/en/latest/).\n\n# Disclaimer:\nBe sure to read the API documentation if you plan to use any of the APIs for development. This package is for accessing keyless, free, open source APIs and I am not responsible for the content of the APIs themselves.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python package for accessing APIs that require no key.",
"version": "0.7.4",
"project_urls": {
"Homepage": "https://github.com/SpyderRex/nokey",
"Repository": "https://github.com/SpyderRex/nokey"
},
"split_keywords": [
"api",
" requests",
" xmltodict"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab2e301dd25b26fd9011bef4ead7e40d2bcf2e98e30325c9df77f73a2bcf40f0",
"md5": "2f8751f729e43eeceb6fe9ece5fb417a",
"sha256": "b675119e691aaa6cda7dd3cd16de0bdaaef99843c13aa5b5c21fc126aa714b69"
},
"downloads": -1,
"filename": "nokey-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f8751f729e43eeceb6fe9ece5fb417a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 87091,
"upload_time": "2024-05-29T00:24:53",
"upload_time_iso_8601": "2024-05-29T00:24:53.428235Z",
"url": "https://files.pythonhosted.org/packages/ab/2e/301dd25b26fd9011bef4ead7e40d2bcf2e98e30325c9df77f73a2bcf40f0/nokey-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fb9aaed2699c49702bb14f3a82c9b7e46966e9bdc7a1a873aca931bec06b585",
"md5": "6a8b11a9db4c47e5d47a9dedd94faed2",
"sha256": "eb1a99accf2babd86bd1621be5e80005739610d9f21ff5dcd5239c8c704facc0"
},
"downloads": -1,
"filename": "nokey-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "6a8b11a9db4c47e5d47a9dedd94faed2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 67550,
"upload_time": "2024-05-29T00:24:55",
"upload_time_iso_8601": "2024-05-29T00:24:55.045353Z",
"url": "https://files.pythonhosted.org/packages/5f/b9/aaed2699c49702bb14f3a82c9b7e46966e9bdc7a1a873aca931bec06b585/nokey-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-29 00:24:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SpyderRex",
"github_project": "nokey",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "xmltodict",
"specs": [
[
"==",
"0.13.0"
]
]
},
{
"name": "requests-cache",
"specs": [
[
"==",
"1.2.0"
]
]
}
],
"lcname": "nokey"
}
JSON
