Metadata-Version: 2.1
Name: twacapic
Version: 0.1.4.3
Summary: A Twitter Academic API Client
Home-page: https://github.com/Leibniz-HBI/twacapic
License: MIT
Author: Felix Victor Münch
Author-email: f.muench@leibniz-hbi.de
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: TwitterAPI (>=2.6.9,<3.0.0)
Project-URL: Repository, https://github.com/Leibniz-HBI/twacapic
Description-Content-Type: text/markdown

# twacapic

Twitter Academic API Client

In development. Expect breaking changes and destructive bugs before updating to the latest version.

Latest presumably working version: 0.1.4.3


## Installation

Install via pip:

`pip install twacapic`


## Usage

To collect the latest 100 tweets of a list of users run:

`twacapic USER_GROUP_NAME PATH_TO_USER_CSV`

`USER_GROUP_NAME` should be the name of the results folder that is meant to be created and will contain raw json responses from Twitter.

`PATH_TO_USER_CSV` should be a path to a list of Twitter user IDs, without header, one line per user ID.

Afterwards you can poll for new tweets of a user group by running simply:

`twacapic USER_GROUP_NAME`

Enjoy!


## Dev Install

1. Install [poetry](https://python-poetry.org/docs/#installation)
2. Clone repository
3. In the directory run `poetry install`
4. Run `poetry shell` to start development virtualenv
5. Run `twacapic` to enter API keys. Ignore the IndexError.
6. Run `pytest` to run all tests

