An asynchronous wrapper in python for the https://dictionaryapi.dev API
Project description
NOTE: Currently I have only implemented fetching words from English, not other languages. This is because the actual API's implementation of languages other than english is different. Support for different languages coming soon though.
Requirements
- Python 3.6+
- aiohttp
Features
- Asynchronous
- Typed
- Easy to use
Installation
Available through PyPi (pip)
$ pip install asyncdictionary
Or through git.
$ pip install git+https://github.com/Ay-355/asyncdictionary
You might have to do
python3 -m pip
Documentation
You can find a markdown file here.
Issues
Any issues directly with the API should be reported at the API's repository page.
If there is anything wrong with this package, feel free to open up an issue and explain what happened.
Examples
An example to print out some information about a word
import asyncdictionary
import asyncio
# create an instance of the client
dictionary = asyncdictionary.Client()
async def word_info(word):
word = await dictionary.get_word(word) # get a Word object
print(f"Word: {word.word}")
print(f"Phonetic text: {word.phonetics[0].text}")
print(f"Part of Speech: {word.meanings[0].part_of_speech}")
print(f"Definition: {word.meanings[0].definitions[0].definition}")
print(f"Synonyms: {', '.join(word.meanings[0].definitions[0].synonyms)}")
print(f"Example: {word.meanings[0].definitions[0].example}")
asyncio.run(word_info("hello"))
Links
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
asyncdictionary-1.2.4.tar.gz
(5.2 kB
view details)
Built Distribution
File details
Details for the file asyncdictionary-1.2.4.tar.gz
.
File metadata
- Download URL: asyncdictionary-1.2.4.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07eba2d60dfb7182c6a467fdc33197e0ba380f0500cfd62fb27b180bdb40ddb7 |
|
MD5 | 4e7e4b9379c40539378fe8e9c16200b9 |
|
BLAKE2b-256 | 23c326273c7195f9d521e0a73ac40cc43391011f12512a73803d87cce93b8754 |
File details
Details for the file asyncdictionary-1.2.4-py3-none-any.whl
.
File metadata
- Download URL: asyncdictionary-1.2.4-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 875a6e9808676b0c46f751202f11bd748f28e7bf91dbbb6df493e7d6713df002 |
|
MD5 | 017d5d3801e091bbdb630e605239ca1a |
|
BLAKE2b-256 | 772ee79adbf447eaa7455dda980557a439e334a879cd3ce3ca591c161cafe668 |