oxfordpy 1.0.0

Description:

oxfordpy 1.0.0

oxfordpy




oxfordpy is a python library for the oxford dictionary API.
Installation
Use the package manager pip to install oxfordpy.

Installation using pip

pip install oxfordpy


Installation from source

git clone https://github.com/spacesudo/oxfordpy.git
cd oxfordpy
python setup.py

Usage
import oxfordpy

dictionary = oxfordpy.Oxford()

search = dictionary.entries("example") #search for "example"

print(search)

Configuration
To configure the library pass your configurations to the oxfordpy() class.
import oxfordpy
oxford = oxfordpy.Oxford(app_id = "<your id>",app_key = "<your key>",timeout = (2,6)) #timeout should be a tuple

Common Issues

Authentification error

Please now that the api key and id used for this package is for test purpose only.
Some features of the API are not accessible with a Developer API credentials.
If you face any other issue please kindly let me know
Roadmap
Please know that this library is still under development
Future updates of this library will have advanced features and probably use other dictionary API like Meriam Webster support and others
while this library is production ready please remember to regularly update the library using pip install oxfordpy --upgrade
Social media
You can follow me on:
Twitter @derankem
or send a message on telegram @spacesudo
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
This project is licensed under the MIT License.