Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Aveek-Saha committed Apr 26, 2022
1 parent 8eb7a3e commit 24ffc61
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,36 @@ pip install tweego
tweego [OPTIONS]
Options:
-fo, --first-order Flag: Collect first order ego
-u, --users Flag: Collect user data
-so, --second-order Flag: Collect second order ego
-g, --graph Flag: Generate graph file
-d, --dir PATH Directory to store data
-k, --keys-file PATH Location of the api keys JSON file
-n, --screen-name TEXT The screen name of the ego center user
-f, --follower-limit INTEGER Number of followers for the second order ego
--version Show the version and exit.
--help Show this message and exit.
```

### Example

Collect everything:

```
tweego -d "dataset" -k "keys.json" -n "github" --fo --u --so -g
```

Collect first order connections only:

```
tweego -d "dataset" -k "keys.json" -n "github" --fo
```

Collect users and second order connections only:

```
tweego -d "dataset" -k "keys.json" -n "github"
tweego -d "dataset" -k "keys.json" -n "github" --u --so
```

## API keys format
Expand Down

0 comments on commit 24ffc61

Please sign in to comment.