Metadata-Version: 2.1
Name: lexisnexisapi
Version: 2.0.40
Summary: A small example package
Home-page: https://github.com/gmyrianthous/example-publish-pypi
Author: Robert Cuffney
Author-email: Robert Cuffney <robert.cuffney@lexisnexis.com>, Ozgur Aycan <ozgur.aycan@lexisnexis.co.uk>
License: MIT
Keywords: example project
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

#lexisnexisapi

##About lexisnexisapi:
lexisnexisapi is a module designed to work with certain LexisNexis DAAS APIs.  
Currently, this module only works with the Metabase API, and requires a Metabase API key.
the Metabase module within lexisnexisapi creates an instance of the MbSearch class based on a query 
provided by the end user.  It takes the JSON response from the Metabase API and places it within a 
Python class.  
It is also possible to create an instance of a class for a specific article, to simplify further analysis.
This class can retrieve dataframes, index terms, or any other
attributes retrieved from the API HTTP response.
The lexisnexisapi is a work in progress... and may not be regularly maintained. 

##Requirements
Beyond system requirements, lexisnexisapi requires an active Metabase API key.
#Required modules
##Configuration
##Troubleshooting & FAQ 
The current version requires a myCredentials.json file that does not download with the module.
The manual workaround is to add a myCredentials.json file to the module folder... future versions
of this module should remove this manual process.
lexisnexisapi has limited built-in error handling and should be considered a beta module.  There
is no guarantee that lexisnexisapi will work in all environments, and 
##Maintainers
This module is not regularly maintained.  It was written and is updated by the
customer service integration specialist within the DAAS customer success team at 
LexisNexis.  It is not, however, a regularly maintained product, and LexisNexis makes 
no representation as to its safety or effectiveness.
