Skip to content

Commit

Permalink
Merge upstream; update lockfile; resolve conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
s2t2 committed Jul 22, 2024
2 parents 493901f + 5bb52f2 commit bf89bbe
Show file tree
Hide file tree
Showing 6 changed files with 143 additions and 94 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@ Currently, this tool can:
* Pull "trending" Truth posts
* Pull ads
* Pull a user's metadata
<<<<<<< HEAD
=======
* Pull the list of users who liked a post
* Pull the list of comments on a post
>>>>>>> main
* Pull "trending" groups
* Pull list of suggested groups
* Pull "trending" group hashtags
* Pull posts from group timeline

Truthbrush is designed for academic research, open source intelligence gathering, and data archival. It pulls all of the data from the publicly accessible API.
Truthbrush is designed for academic research, open source intelligence gathering, and data archival. It pulls all data from the publicly accessible API.

## Installation

Expand All @@ -39,6 +44,7 @@ Options:
Commands:
<<<<<<< HEAD
search Search for users, statuses, groups, or hashtags.
statuses Pull a user's statuses.
suggestions Pull the list of suggested users.
Expand All @@ -48,9 +54,22 @@ Commands:
user Pull a user's metadata.
likes Pull the list of users who liked a post
groupposts Pull posts from a groups's timeline
=======
search Search for users, statuses or hashtags.
statuses Pull a user's statuses.
suggestions Pull the list of suggested users.
tags Pull trendy tags.
trends Pull trendy Truths.
ads Pull ads.
user Pull a user's metadata.
likes Pull the list of users who liked a post
comments Pull the list of oldest comments on a post
groupposts Pull posts from a groups's timeline
>>>>>>> main
grouptags Pull trending group tags.
grouptrends Pull trending groups.
groupsuggestions Pull list of suggested groups.
``````
**Search for users, statuses, groups, or hashtags**
Expand Down Expand Up @@ -90,7 +109,13 @@ truthbrush user HANDLE
**Pull the list of users who liked a post**

```bash
truthbrush likes POST TOP_NUM
truthbrush likes POST --includeall TOP_NUM
```

**Pull the list of oldest comments on a post**

```bash
truthbrush comments POST --includeall --onlyfirst TOP_NUM
```

**Pull trending group tags**
Expand Down Expand Up @@ -133,7 +158,7 @@ truthbrush --help # will use your local copy of truthbrush
If you prefer not to install Poetry in your root environment, you can also use Conda:

```sh
conda create -n truthbrush-env python=3.9
conda create -n truthbrush-env python=3.10
conda activate truthbrush-env

conda install -c conda-forge poetry
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you use VS Code, you can also consider installing the [Quarto Extension](http
Setup environment and install package dependencies:

```sh
conda create -n truthbrush-docs python=3.9
conda create -n truthbrush-docs python=3.10
conda activate truthbrush-docs

conda install -c conda-forge poetry
Expand Down
Loading

0 comments on commit bf89bbe

Please sign in to comment.