Skip to content

Commit f236883

Browse files
authored
Update README.md
1 parent d14cb60 commit f236883

File tree

1 file changed

+53
-4
lines changed

1 file changed

+53
-4
lines changed

README.md

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,77 @@
11

2+
3+
24
# AndroidFileHost Scraper
5+
36
Simple and powerful Python script to look for keywords and download files from AndroidFileHost by imitating their API calls. Supports downloading from multiple pages, mirror selection and sorting pages.
47

8+
9+
510
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/codefl0w/AndroidFileHostScraper/total?style=flat-square&logo=github) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/codefl0w/AndroidFileHostScraper/.github%2Fworkflows%2Fbuild.yml?style=flat-square&label=Executable%20build%20workflow)
611

7-
12+
813

14+
15+
916

1017
## Why?
1118

19+
20+
1221
AFH is slowly dying, which means a lot of ROMs, kernels and whatnot will be forever gone if we don't archive them elsewhere. This script makes everything a lot easier.
1322

23+
24+
1425
## Installation
15-
Get the requirements: `pip install requests beautifulsoup4`
16-
And run the script.
26+
27+
Get the requirements: `pip install requests beautifulsoup4`
28+
29+
And run the script.
30+
31+
1732

1833
You can also check the [releases](https://github.com/codefl0w/AndroidFileHostScraper/releases) page to download precompiled executables for your platform if you don't want to install Python. Releases are created automatically using GitHub Actions and mostly untested, so please create an issue if you encounter a problem.
1934

35+
36+
2037
Lastly, you can install the PyPi distribution globally by running `pip install AndroidFileHostScraper`. You can then call it via either `AndroidFileHostScraper` or `afhscraper` in your terminal.
2138

39+
40+
2241
## Usage
23-
Just run the tool, search for keywords, select how the files should be sorted, choose the amount of files to download, select your primary server and hit enter. The scraper will automatically go through the files and download them.
42+
43+
### Interactive mode
44+
45+
Just run the tool, search for keywords, select your preferences and wait. The scraper will automatically go through the files and download them.
2446

2547
Downloads can be found within the root directory of the script.
2648

49+
### CLI Mode
50+
51+
AFHScraper V2.0.0 and later can take positional arguements and run like a CLI tool.
52+
53+
options:
54+
-h, --help show this help message and exit
55+
-s, --search SEARCH Search terms (comma-separated)
56+
--sort {newest,popular}
57+
Sort order (newest or popular)
58+
-n, --files FILES Maximum files to download per search term
59+
-m, --mirror {usa,germany}
60+
Preferred mirror location
61+
-t, --threads THREADS
62+
Number of concurrent downloads (default: 1)
63+
-o, --output OUTPUT Download directory
64+
-l, --log-level {DEBUG,INFO,WARNING,ERROR}
65+
Logging level (default: INFO)
66+
67+
68+
This can be used to automate downloads. It also lets the user to specify an output directory unlike the interactive mode.
69+
70+
### Extras
71+
72+
Enjoy my work? Please consider a small donation!
2773

74+
<a href="https://buymeacoffee.com/fl0w" target="_blank" rel="noopener noreferrer">
75+
<img width="350" alt="yellow-button" src="https://github.com/user-attachments/assets/2e6d44c8-9640-4cb3-bcc8-989595d6b7e9"/>
76+
</a>
2877

0 commit comments

Comments
 (0)