Metadata-Version: 2.1
Name: twb
Version: 1.0.2
Summary: Twitter backup crawler
Author-email: Azalea Gui <me@hydev.org>
License: MIT License
        
        Copyright (c) 2022 Hykilpikonna
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        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.
        
Project-URL: Homepage, https://github.com/one-among-us/TwitterBackup
Keywords: twitter,backup
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# TwitterBackup

A tool to back up other users' Twitter accounts using the Twitter API. (Currently limited to the last 3200 tweets).

https://user-images.githubusercontent.com/22280294/207434663-a2fa6170-d740-4f35-82f6-df41bdce8837.mp4

## Usage

1. Install python `>= 3.7` (Tested on python 3.11)
2. `pip install twb`
3. [Register for a Twitter API token](https://developer.twitter.com/en/portal/dashboard)
4. Put your tokens in `$HOME/.config/twb/config.toml` or `./config.toml`.   
  You can reference the example config below
5. Run command `twb <username>`, and it will download to `./backups`

#### Example Config

```toml
# The consumer key from the Twitter application portal (https://developer.twitter.com/en/portal/dashboard)
consumer_key = '#########################'
# The consumer secret from the Twitter application portal
consumer_secret = '##################################################'
# The access token of an app from the Twitter application portal
access_token = '##################################################'
# The access secret of an app from the Twitter application portal
access_secret = '#############################################'
```
