mirror of https://github.com/balkian/bitter.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
8 years ago
|
#Description
|
||
|
|
There are two parts to bitter.
|
||
|
|
First of all, it is a wrapper over Python twitter that adds support for several Twitter API credentials (e.g. authorizing the same app with different user accounts).
|
||
|
|
Secondly, it is a command line tool to automate several actions (e.g. downloading user networks) using the wrapper.
|
||
|
|
|
||
|
|
# Instructions
|
||
|
|
|
||
|
|
In the command line:
|
||
|
|
|
||
|
|
python -m bitter --help
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
bitter --help
|
||
|
|
|
||
|
|
|
||
|
|
Programmatically:
|
||
|
|
|
||
|
|
```python
|
||
|
|
from bitter.crawlers import TwitterQueue
|
||
|
|
wq = TwitterQueue.from_credentials()
|
||
|
|
print(wq.users.show(user_name='balkian'))
|
||
|
|
```
|
||
|
|
|
||
|
|
# Credentials format
|
||
|
|
|
||
|
|
```
|
||
|
|
{"user": "balkian", "consumer_secret": "xxx", "consumer_key": "xxx", "token_key": "xxx", "token_secret": "xxx"}
|
||
|
|
```
|
||
|
|
|
||
|
|
By default, bitter uses '~/.bitter-credentials.json', but you may choose a different file:
|
||
|
|
|
||
|
|
```
|
||
|
|
python -m bitter -c <credentials_file> ...
|
||
|
|
```
|
||
|
|
|
||
|
|
# Server
|
||
|
|
To add more users to the credentials file, you may run the builtin server, with the consumer key and secret of your app:
|
||
|
|
|
||
|
|
```
|
||
|
|
python -m bitter server <consumer_key> <consumer_secret>
|
||
|
|
```
|
||
|
|
|
||
|
|
# Notice
|
||
|
|
Please, use according to Twitter's Terms of Service
|
||
|
|
|
||
|
|
# TODO
|
||
|
|
|
||
|
|
* Tests
|
||
|
|
* Docs
|