bellingcat/snscrape
1
0
Fork 0
mirror of https://github.com/bellingcat/snscrape.git synced 2026-06-12 20:38:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add README, LICENSE, and metadata

Browse Source
This commit is contained in:
JustAnotherArchivist
2018-09-10 22:15:03 +02:00
parent 0350ab0692
commit cf36e8be97
3 changed files with 723 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md Normal file
View File

@@ -0,0 +1,41 @@
# snscrape
snscrape is a scraper for social networking services (SNS). It scrapes things like user profiles, hashtags, or searches and returns the discovered items, e.g. the relevant posts.
The following services are currently supported:
* Facebook: user profiles
* Google Plus: user profiles
* Instagram: user profiles
* Twitter: user profiles, hashtags, and searches
## Requirements
snscrape requires Python 3.6 or higher. The Python package dependencies are installed automatically when you install snscrape.
Note that one of the dependencies, lxml, also requires libxml2 and libxslt to be installed.
## Installation
pip3 install git+https://github.com/JustAnotherArchivist/snscrape.git
## Usage
To get all tweets by Jason Scott (@textfiles):
snscrape twitter-user textfiles
It's usually useful to redirect the output to a file for further processing, e.g. in bash using the filename `@textfiles-tweets`:
```bash
snscrape twitter-user textfiles >@textfiles-tweets
```
To get the latest 100 tweets with the hashtag #archiveteam:
snscrape --max-results 100 twitter-hashtag archiveteam
`snscrape --help` or `snscrape <module> --help` provides details on the available options. `snscrape --help` also lists all available modules.
It is also possible to use snscrape as a library in Python, but this is currently undocumented.
## License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.