Update README.md

This commit is contained in:
Haris Muneer ⚡️ 2020-12-11 19:43:38 +05:00 committed by GitHub
parent 72954e441d
commit 389758c709
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 99 deletions

100
README.md
View File

@ -126,8 +126,7 @@ A bot which scrapes almost everything about a user's Facebook profile including:
- tagged photos
- videos
- friends list and their profile photos (including Followers, Following, Work Friends, College Friends etc)
- and all public posts/statuses available on the user's timeline
- **NEW:** Now you can scrape Facebook group posts.
- and public posts/statuses available on the user's timeline
Data is scraped in an organized format to be used for educational/research purposes by researchers. This scraper does not use Facebook's Graph API meaning there are no rate limiting issues.
@ -135,14 +134,6 @@ Data is scraped in an organized format to be used for educational/research purpo
For **citing/referencing** this tool for your research, check the 'Citation' section below.
## Note 🤝
This tool uses xpaths of **'divs'** to extract data. Since Facebook updates its site frequently, the 'divs' get changed. Consequently, we have to update the divs accordingly to correctly scrape data.
The developers of this tool have devoted time and effort in developing, and maintaining this tool for a long time. **In order to keep this amazing tool alive, we need support from you geeks.**
The code is intuitive and easy to understand, so you can update the relevant xpaths in the code if you find data is not being scraped from profiles. Facebook has most likely updated their site, so please generate a pull request. Much appreciated!
## Sample
<p align="middle">
@ -155,73 +146,6 @@ The code is intuitive and easy to understand, so you can update the relevant xpa
<img src="https://user-images.githubusercontent.com/30947706/79589002-259f7380-80ee-11ea-959a-bddf0e2f6629.png" width="700"/>
</p>
---
## Usage 🔧
### Installation 💻
You will need to:
- Install latest version of [Google Chrome](https://www.google.com/chrome/).
- Install [Python 3](https://www.python.org/downloads/)
- Have a Facebook account without 2FA enabled
```bash
git clone https://github.com/harismuneer/Ultimate-Facebook-Scraper.git
cd Ultimate-Facebook-Scraper
# Install Python requirements
pip install -e .
```
The code is multi-platform and is tested on both Windows and Linux.
Chrome driver is automatically downloaded using the chromedriver_manager package.
### How to Run
- Fill your Facebook credentials into [`credentials.yaml`](credentials.yaml)
- Edit the [`input.txt`](input.txt) file and add profile, groups and individual group posts links as you want in the following format with each link on a new line:
Make sure the link only contains the username or id number at the end and not any other stuff. Make sure its in the format mentioned above.
Run the `ultimate-facebook-scraper` command ! 🚀
```python
python scraper/scraper.py
```
> Note: There are two modes to download Friends Profile Pics and the user's Photos: Large Size and Small Size. By default they are set to Small Sized Pics because its really quick while Large Size Mode takes time depending on the number of pictures to download.
You can personalize your scrapping needs using the command line arguments:
```bash
python scraper/scraper.py \
--uploaded_photos True \
--friends_photos True \
--friends_small_size True \
--photos_small_size True \
--total_scrolls 2500 \
--scroll_time 8
```
Note that those are the default values so no need to write them down if you're just testing or are okay with them.
## Chromium
Chromium users can add `--chromium True` to run using the Chromium browser.
```bash
python scraper/scraper.py \
--uploaded_photos True \
--photos_small_size True \
--total_scrolls 2500 \
--scroll_time 8 \
--chromium True
```
---
## Citation 📚
@ -238,8 +162,6 @@ If you use this tool for your research, then kindly cite it. Click the above bad
This tool is for research purposes only. Hence, the developers of this tool won't be responsible for any misuse of data collected using this tool. Used by many researchers and open source intelligence (OSINT) analysts.
This tool will not works if your account was set up with 2FA. You must disable it before using.
---
## Authors 👋
@ -269,26 +191,6 @@ If you or your company use any of my projects or like what Im doing then cons
- 🔰 **$49.99 (one-time sponsor)** [Support an hour of maintenance](https://tinyurl.com/Haris-OSS-Gold)
- ☕️ **$9.99 (one-time sponsor)** [Lunch/coffee](https://tinyurl.com/Haris-OSS-Silver)
## For Future 🔮
Shoutout to geeks willing to contribute to this project. Please have a look at the [UFS kanban board](https://github.com/harismuneer/Ultimate-Facebook-Scraper/projects/1) for a list of things to be done.
There are a lot of features that can be added to this tool like adding support for pages, groups, comments etc! Please contribute :)
## Contributions Welcome ✨
![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)
If you find any bug in the code or have any improvements in mind then feel free to generate a pull request.
> Note: We use [Black](https://pypi.org/project/black/) to lint Python files. Please use it in order to have a valid pull request 😉
## Issues 🔨
[![GitHub Issues](https://img.shields.io/github/issues/harismuneer/Ultimate-Facebook-Scraper.svg?style=flat&label=Issues&maxAge=2592000)](https://www.github.com/harismuneer/Ultimate-Facebook-Scraper/issues)
If you face any issue, you can create a new issue in the Issues Tab and I will be glad to help you out.
## License 📄
[![MIT](https://img.shields.io/cocoapods/l/AFNetworking.svg?style=style&label=License&maxAge=2592000)](LICENSE)