Metadata-Version: 2.1
Name: accern-data
Version: 0.0.1
Summary: Client for consuming Accern data feeds.
Home-page: https://github.com/Accern/accern-data-client
Author: Accern Corp.
Author-email: datascience@accern.com
License: MIT
Keywords: api client data feed NLP processing
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas (>=1.4.1)
Requires-Dist: requests (>=2.27.1)
Requires-Dist: tqdm (~=4.64.0)
Requires-Dist: typing-extensions (>=4.0.1)

# Accern Data Library
[![Python Checks](https://github.com/Accern/accern-data-client/actions/workflows/python-app.yml/badge.svg)](https://github.com/Accern/accern-data-client/actions/workflows/python-app.yml)

Client library for consuming Accern data feed API.


### Installation:
```
pip install accern-data
```


### Sample snippet:


```python
>>> import accern_data
# Create a data client.
>>> client = accern_data.create_data_client("http://api.example.com/", "SomeRandomToken")
# Set a data format/mode in which the data has to be downloaded.
>>> client.set_mode("csv_date")  # Other modes: {"csv_full", "json"}
```


### Set filters:
```python
>>> client.set_filters({
        "provider_ID": Optional[str],
        "entity_name": Optional[str],
        "event": Optional[str],
        "entity_ticker": Optional[str],
        "entity_accern_id": Optional[str],
    })
```





### Set parameters to the download function:
```python
>>> client.download_range(
        start_date="2022-01-03",
        output_path="./",
        output_pattern="data",
        end_date="2022-03-04")
```

Note: To download single day's data, set `end_date=None` or can leave that unset:
```python
>>> client.download_range(
        start_date="2022-01-03",
        output_path="./",
        output_pattern="data",
        end_date=None)
```
OR

```python
>>> client.download_range(
        start_date="2022-01-03",
        output_path="./",
        output_pattern="data")
```


