Metadata-Version: 2.1
Name: currentsapi
Version: 0.0.1
Summary: Official Python client for the Currents API
Home-page: https://github.com/currentsapi-dev/currentsapi-python
Author: Zhi Rui Tam
Author-email: ray@currentsapi.services
License: MIT
Download-URL: https://github.com/currentsapi-dev/currentsapi-python/archive/master.zip
Keywords: currentsapi,news,wrapper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.21.0)
Requires-Dist: python-dateutil (==2.8.0)

# currentsapi-python
A Python client for the [Currents API](https://currentsapi.services/documents)

##### Provided under MIT License by Zhi Rui Tam.
*Note: this library may be subtly broken or buggy. The code is released under
the MIT License – please take the following message to heart:*
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## General 

This is a Python client library for CurrentsAPI version 1. The functions for the library should mirror the
endpoints from the [documentation](https://currentsapi.services/documents). 

## Installation
Installation for the package can be done via pip.

```commandline
    pip install currentsapi-python
```

## Usage

After installation, import client into your project:

```python
from currentsapi import CurrentsAPI
```

Initialize the client with your API key:

```python
api = CurrentsAPI(api_key='XXXXXXXXXXXXXXXXXXXXXXX')
```

### Endpoints

#### Latest News

```python
api.latest()
```
#### Query

```python
api.search(keywords='Trump')
```



