mirror
/
Ultimate-Facebook-Scraper
mirror of https://github.com/harismuneer/Ultimate-Social-Scrapers.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

This commit is contained in:
Quentin Lemaire 2019-11-30 00:45:56 +01:00
parent 20b56140c3
commit 21e241a763
No known key found for this signature in database
GPG Key ID: 5A99AA8DCE71630E
3 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@ -116,6 +116,5 @@ dmypy.json
## Generated data
src/Data
## Input files
input.txt
credentials.txt
## Python venv
venv

40
README.md
View File

@ -107,29 +107,37 @@ The code is intuitive and easy to understand, so you can update the relevant xpa
### Installation
You will need to install latest version of [Google Chrome](https://www.google.com/chrome/). Moreover, you need to install selenium module as well using
You will need to:
```
pip install selenium
- 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
# Set up a virtual env
$ python3 -m venv venv
$ source venv/bin/activate
# Install Python requirements
$ pip install -r requirements.txt
```
Run the code using Python 3. Also, the code is multi-platform and is tested on both Windows and Linux.
The tool uses latest version of [Chrome Web Driver](http://chromedriver.chromium.org/downloads). I have placed the webdriver along with the code but if that version doesn't work then replace the chrome web driver with the latest one.
The code is multi-platform and is tested on both Windows and Linux.
The tool uses latest version of [Chrome Web Driver](http://chromedriver.chromium.org/downloads). I have placed the webdriver along with the code but if that version doesn't work then replace the chrome web driver with the latest one according to your platform and your Google Chrome version.
### How to Run
Create a file named "input.txt" and add as many profiles as you want in the following format with each link on a new line:
```
https://www.facebook.com/andrew.ng.96
https://www.facebook.com/zuck
```
- Fill your Facebook credentials into [`src/credentials.yaml`](src/credentials.yaml)
- Edit the [`src/input.txt`](src/input.txt) file and add many profiles 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.
Note: There are two modes to download Friends Profile Pics and the user's Photos: Large Size and Small Size. You can change the following variables. 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
> Note: There are two modes to download Friends Profile Pics and the user's Photos: Large Size and Small Size. You can change the following variables. 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
```
```python
# whether to download the full image or its thumbnail (small size)
# if small size is True then it will be very quick else if its False then it will open each photo to download it
# and it will take much more time
@ -177,10 +185,12 @@ If you liked the repo then kindly support it by giving it a star ⭐!
## Contributions Welcome
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](#)
![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: Wee 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)
@ -189,6 +199,6 @@ If you face any issue, you can create a new issue in the Issues Tab and I will b
## License
[![MIT](https://img.shields.io/cocoapods/l/AFNetworking.svg?style=style&label=License&maxAge=2592000)](../master/LICENSE)
[![MIT](https://img.shields.io/cocoapods/l/AFNetworking.svg?style=style&label=License&maxAge=2592000)](LICENSE)
Copyright (c) 2018-present, harismuneer, Hassaan-Elahi

2
src/input.txt Normal file
View File

@ -0,0 +1,2 @@
https://www.facebook.com/andrew.ng.96
https://www.facebook.com/zuck