Metadata-Version: 2.1
Name: py-oxford
Version: 1.0.1.dev0
Summary: A sample Python project
Home-page: https://github.com/spacesudo/pyoxford
Author: spacesudo
Author-email: chiderankem2@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/spacesudo/pyoxford/issues
Project-URL: Source, https://github.com/spacesudo/pyoxford/
Description: 
        # pyoxford
        [![GitHub issues](https://img.shields.io/github/issues/spacesudo/pyoxford)](https://github.com/spacesudo/pyoxford/issues)
        [![GitHub forks](https://img.shields.io/github/forks/spacesudo/pyoxford)](https://github.com/spacesudo/pyoxford/network)
        [![GitHub stars](https://img.shields.io/github/stars/spacesudo/pyoxford)](https://github.com/spacesudo/pyoxford/stargazers)
        [![GitHub license](https://img.shields.io/github/license/spacesudo/pyoxford)](https://github.com/spacesudo/pyoxford/blob/master/LICENSE.txt)
        
        pyoxford is a python library for the [oxford dictionary API](https://developer.oxforddictionaries.com/).
        
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pyoxford.
        
        >Installation using pip
        
        ```bash
        pip install py-oxford
        ```
        >Installation from source
        
        ```bash
        git clone https://github.com/spacesudo/pyoxford.git
        cd pyoxford
        python setup.py
        ```
        
        ## Usage
        
        ```python
        from pyoxford import pyOxford
        
        dictionary = pyOxford()
        
        search = dictionary.entries("example") #search for "example"
        
        print(search)
        
        ```
        
        ## Configuration
        To configure the library pass your configurations to the *pyOxford()* class.
        ```python
        from pyoxford import pyOxford
        oxford = pyOxford(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 for Meriam Webster support and others
        
        *while this library is production ready please remember to regularly update the library using ```pip install py-oxford --upgrade```*
        
        ## Social media
        
        You can follow me on:
         
        Twitter [@derankem](https://twitter.com/derankem) 
        
        or send a message on telegram [@spacesudo](https://t.me/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](https://choosealicense.com/licenses/mit/) License. 
Keywords: oxford,dictionary,development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
