Metadata-Version: 2.1
Name: twock
Version: 0.1.2
Summary: Ping/Knock a list of tweets to enquire their status (deleted/available/...) #twockknock
Home-page: https://github.com/Leibniz-HBI/twock
License: MIT
Author: Felix Victor Münch
Author-email: f.muench@leibniz-hbi.de
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - 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.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: click (>=8.0.1,<9.0.0)
Requires-Dist: loguru (>=0.5.3,<0.6.0)
Requires-Dist: ndjson (>=0.3.1,<0.4.0)
Requires-Dist: pandas (>=1.3.1,<2.0.0)
Requires-Dist: twarc (>=2.3.10,<3.0.0)
Project-URL: Repository, https://github.com/Leibniz-HBI/twock
Description-Content-Type: text/markdown

# twock

Ping/knock a list of tweets and return reachability issues (deleted/protected/withheld...) #twockknock

## Usage

### Knocking Tweets

```txt
twock knock [OPTIONS] TWEETFILE

  Ping (knock) a list of tweets. Expects file path to CSV with `id` column.

Options:
  --outpath TEXT    Path to output file, will be prefixed with today's date.
                    Default: `errors.ndjson`
  --tkpath TEXT     Path to Twitter API v2 bearer token YAML file. Default:
                    `bearer_token.yaml`
  --sample INTEGER  If given, sample INTEGER number of tweets only
  --help            Show this message and exit.
```

### Authentification

You need to have access to the Twitter V2 API and t obtain a valid bearer token. Replace the template value in `bearer_token.yml` with your actual credentials.

## Developer Install

1. Install [poetry](https://python-poetry.org/docs/#installation)
2. Clone repository
3. In the cloned repository's root 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

