Metadata-Version: 2.1
Name: twcollect
Version: 0.1.0
Summary: Simple CLI to collect data from the Twitter stream API
Home-page: https://github.com/smassonnet/twcollect
Author: Stephane Massonnet
Author-email: stephane.massonnet@epfl.ch
License: MIT
Project-URL: Documentation, https://github.com/smassonnet/twcollect
Project-URL: Source, https://github.com/smassonnet/twcollect
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: testing
License-File: LICENSE.txt

<!-- These are examples of badges you might want to add to your README:
     please update the URLs accordingly

[![Built Status](https://api.cirrus-ci.com/github/<USER>/twcollect.svg?branch=main)](https://cirrus-ci.com/github/<USER>/twcollect)
[![ReadTheDocs](https://readthedocs.org/projects/twcollect/badge/?version=latest)](https://twcollect.readthedocs.io/en/stable/)
[![Coveralls](https://img.shields.io/coveralls/github/<USER>/twcollect/main.svg)](https://coveralls.io/r/<USER>/twcollect)
[![PyPI-Server](https://img.shields.io/pypi/v/twcollect.svg)](https://pypi.org/project/twcollect/)
[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/twcollect.svg)](https://anaconda.org/conda-forge/twcollect)
[![Monthly Downloads](https://pepy.tech/badge/twcollect/month)](https://pepy.tech/project/twcollect)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/twcollect)
-->

[![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)

# `twcollect`

> Simple CLI to collect data from the Twitter stream API

## Installation

```
pip install twcollect
```

## Usage

Create a credentials file with the following format:

```yml
twitter_token: "<TWITTER_BEARER_TOKEN>"
```

See the CLI help for details on how to use:

```shell
python -m twcollect --help
```

<!-- pyscaffold-notes -->

## Note

This project has been set up using PyScaffold 4.3.1. For details and usage
information on PyScaffold see https://pyscaffold.org/.
