Package: umbraSenscraping
umbraSnscrapeumbraSnscrape 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, groups, and communities (aka visitor posts)Instagram: user profiles, hashtags, and locationsMastodon: user profiles and toots (single or thread)Reddit: users, subreddits, and searches (via Pushshift)Telegram: channelsTwitter: users, user profiles, hashtags, searches, tweets (single or surrounding thread), list posts, and trendsVKontakte: user profilesWeibo (Sina Weibo): user profilesRequirementssnscrape requires Python 3.8 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.Installationpip3 install umbraSnscrapeUsageCLIThe generic syntax of umbraSnscrape's CLI is:umbraSnscrape [GLOBAL-OPTIONS] SCRAPER-NAME [SCRAPER-OPTIONS] [SCRAPER-ARGUMENTS...]umbraSnscrape --helpandumbraSnscrape SCRAPER-NAME --helpprovide details on the options and arguments.snscrape --helpalso lists all available scrapers.The default output of the CLI is the URL of each result.Some noteworthy global options are:--jsonlto get output as JSONL. This includes all information extracted by snscrape (e.g. message content, datetime, images; details vary by scraper).--max-results NUMBERto only return the firstNUMBERresults.--with-entityto get an item on the entity being scraped, e.g. the user or channel. This is not supported on all scrapers. (You can use this together with--max-results 0to only fetch the entity info.)ExamplesCollect all tweets by Jason Scott (@textfiles):umbraSnscrape twitter-user textfilesIt's usually useful to redirect the output to a file for further processing, e.g. in bash using the filenametwitter-@textfiles:srctwitter-usertextfiles>twitter-@textfilesTo get the latest 100 tweets with the hashtag #archiveteam:umbraSnscrape --max-results 100 twitter-hashtag archiveteamLibraryIt is also possible to use umbraSnscrape as a library in Python, but this is currently undocumented.Issue reportingIf you discover an issue with umbraSnscrape, please report it athttps://github.com/JustAnotherArchivist/snscrape/issues. If possible please run snscrape with-vvand--dump-localsand include the log output as well as the dump files referenced in the log in the issue. Note that the files may contain sensitive information in some cases and could potentially be used to identify you (e.g. if the service includes your IP address in its response). If you prefer to arrange a file transfer privately, just mention that in the issue.LicenseThis 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, seehttps://www.gnu.org/licenses/.