<div align="center">
<p>
<a href="#"><img src="images\d.jpeg" width="600" height="300" alt="overview image" /></a>
</p>
</div>
# Alibaba-CLI-Scraper
Is a python package that provides a dedicated CLI interface for scraping data from Alibaba.com.
The purpose of this project is to extract products and theirs related suppliers informations from Alibaba.com and store it in a local database (SQLite or MySQL). The project utilizes asynchronous requests for efficient handling of numerous requests and allows users to easily run the scraper and manage the database using a user-friendly command-line interface (CLI).
**Features:**
* **Asynchronous Scraping:** Utilizes asynchronous API of Playwright for efficient handling of numerous requests.
* **Database Integration:** Stores scraped data in a database (SQLite or MySQL) for structured persistence.
* **User-Friendly CLI:** Provides easy-to-use commands for running the scraper and managing the database.
### Installation
1. **Install tool from pypi:**
to avoid any issues, with other packages or depencies installed in your machine, this tool should be installed with pipx to create isolated environments before to run it:
```bash
pipx install ali2b-cli-scrapper
```
## Behind the Scene: How I Tackled Web Scraping Challenges
Developing a web scraper comes with its own set of hurdles, and this project was no exception! Here's how I overcame some common obstacles:
### The Challenges
* **IP Blocking:** Websites often block requests coming from the same IP address repeatedly, suspecting automated activity.
* **User-Agent Blocking:** Identifying a scraper by its user-agent string (which reveals it's not a regular browser) is another common tactic.
* **Pagination Bottleneck:** For a single keyword, Alibaba often returns numerous search results spread across multiple pages. Fetching data from each page sequentially would take far too long.
### My Solution
To overcome these challenges, I leveraged the power of three key tools and techniques:
1. **Playwright and Asynchronous Requests:** I used Playwright, a powerful Python library, to simulate a real web browser. But I took it a step further! By harnessing Playwright's asynchronous API alongside Python's `asyncio` library, I could fetch data from multiple pages concurrently. For instance, if a search yielded 42 pages of results, my scraper would send requests to all 42 pages simultaneously and process the HTML content as each page loaded, rather than waiting for each page to load one by one. This drastically sped up the scraping process.
2. **BrightData:** This is where BrightData came in! They provide a robust proxy network that routes my requests through different IPs, effectively bypassing IP blocks. It's like a cloak of anonymity for my scraper!
* BrightData's expertise in handling anti-scraping measures was crucial to this project's success.
* To make things easier for you, I've included my BrightData credentials in the code. Please note that these might have limited usage. If you encounter issues with the `run-scrapper` command, you can easily create a free BrightData account (they offer $5 credit!) and plug in your own credentials.
[Get started with BrightData](https://brightdata.com/)
---
## Using the CLI Interface
This project provides a user-friendly command-line interface (CLI) built with `typer` for interacting with the scraper and database.
### Available Commands:
**Need Help?** Type the any commands followed by `--help` for detailed information about its usage and options. For example: `python -m ali2b-cli-scrapper run-scrapper --help`
<div align="center">
<p>
<a href="#"><img src="images\run-scrapper-help-message.png" width="600" height="300" alt="command result 1" /></a>
</p>
<p align="center">
</p>
</div>
The best way to learn is by practice isn't ? So let's get started with a use case example.
Let's suppose that you want to scrape data about electric bikes from Alibaba.com.
* **`run-scrapper`:** Initiates scraping of Alibaba.com based on the provided keywords.
this command takes one required argument and one optional argument:
* **`key_words` (required):** The search term(s) for finding products on Alibaba. Enclose multiple keywords in quotes.
* **`--html-folder` (optional):** Specifies the directory to store the raw HTML files. If omitted, a folder with sanitized keywords as name will be automatically created.
**Example**:
```bash
python -m ali2b_cli_scrapper run-scrapper "electric bikes" --html-folder bike_results
```
if `--html-folder` option is not provided, a folder with sanitized keywords as name will be automatically created and should result to `electric_bikes` as a results folder name.
after that `bike_results` directory has been created and should contains all html files from alibaba.com matching your keywords.
Then you must initialize a database. Mysql and sqlite are supported.
* **`db-init`:** Creates a new database mysql/sqlite.
this command takes one required arguments and six optional arguments(depends on engine you choose):
* **`--engine` (required):** Choose either `sqlite` or `mysql`.
* **`--sqlite-file` (optional, SQLite only):** The name for your SQLite database file (without the extension).
* **`--host`, `--port`, `--user`, `--password`, `--db-name` (required for MySQL):** Your MySQL database connection details.
* **`--only-with` (optional Mysql):** If you just want to update some details of your credentials in `db_credentials.json` file but not all before to initialize an brand new database.
**MySQL Example:**
```bash
python -m ali2b_cli_scrapper db-init mysql --user "mysql_username" --password "mysql_password" --db-name "alibaba_products"
```
Assuming that you have already initialized your database,and you want to created a new one without updating all your credentials, simply run :
```bash
python -m ali2b_cli_scrapper db-init mysql --db-name "alibaba_products" --only-with
```
**NB: This commands will save your credentials in `db_credentials.json` file, so when you will need to update your database, simply run `python src/app.py db-update mysql --kw-results bike_results\` to automatically update your database and using your saved credentials**
**SQLite Example:**
```bash
python -m ali2b_cli_scrapper db-init sqlite --sqlite-file alibaba_data
```
As soons as your database is initialized, you can update it with the scraped data.
* **`db-update`:** Updates your chosen database with the scraped data.
this command takes two required arguments and two optional arguments:
* **`--db-engine` (required):** Select your database engine: `sqlite` or `mysql`.
* **`--kw-results` (required):** The path to the folder containing the HTML files generated by the `run-scrapper` command.
* **`--filename` (required for SQLite):** If you're using SQLite, provide the desired filename for your database. whitout any extension.
* **`--db-name` (optional for MySQL):** If you're using MySQL,and want to push the data to a different database, provide the desired database name.
**NB:What if you want to change something while you updating the database? Assuming that you have run another scraping command and you want to save this data in another database name whitout update credential file or rewriting all theses parameter just to change your database name then, simply run `python src/app.py db-update mysql --kw-results another_keyword_folder_result\ --db-name "another_database_name"`.**
**MySQL Example:**
```bash
python -m ali2b_cli_scrapper db-update mysql --kw-results bike_results\
```
**SQLite Example:**
```bash
python -m ali2b-cli-scrapper db-update sqlite --kw-results bike_results\ --filename alibaba_data
```
**NB: If for any reason you encounter an issue with async api which is set by default, you can use instead sync api by specifying `--sync-api` flag cause is more stable than the other.**
## Future Enhancements
This project has a lot of potential for growth! Here are some exciting features I'm considering for the future:
* **Data Export:** Add functionality to export scraped data to various formats like CSV and Excel spreadsheets for easier analysis and sharing.
* **PostgreSQL Support:** Expand database compatibility to include PostgreSQL, giving users more database choices.
* **Retrieval Augmented Generation (RAG):** Integrate a RAG system that allows users to ask natural language questions about the scraped data, making it even more powerful for insights.
## Contributions Welcome!
I believe in the power of open source! If you'd like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. I'm always open to new ideas and improvements.
## License
This project is licensed under the [Gnu General Public License Version **3**](COPYING).
Raw data
{
"_id": null,
"home_page": "https://github.com/poneoneo/Alibaba-CLI-Scrapper",
"name": "ali2b-cli-scrapper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "cli, scrapping, alibaba, scrapper, alibaba-cli-scrapper",
"author": "poneoneo",
"author_email": "onealzero@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/71/1c/60eb350a03659b2059d26f74c5f0b1a3c46ff38862e9f76fac6a91dd93a8/ali2b_cli_scrapper-1.0.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <p>\n <a href=\"#\"><img src=\"images\\d.jpeg\" width=\"600\" height=\"300\" alt=\"overview image\" /></a>\n </p>\n</div>\n\n# Alibaba-CLI-Scraper\n\nIs a python package that provides a dedicated CLI interface for scraping data from Alibaba.com.\nThe purpose of this project is to extract products and theirs related suppliers informations from Alibaba.com and store it in a local database (SQLite or MySQL). The project utilizes asynchronous requests for efficient handling of numerous requests and allows users to easily run the scraper and manage the database using a user-friendly command-line interface (CLI).\n\n**Features:**\n\n* **Asynchronous Scraping:** Utilizes asynchronous API of Playwright for efficient handling of numerous requests.\n* **Database Integration:** Stores scraped data in a database (SQLite or MySQL) for structured persistence.\n* **User-Friendly CLI:** Provides easy-to-use commands for running the scraper and managing the database.\n\n### Installation\n\n1. **Install tool from pypi:**\nto avoid any issues, with other packages or depencies installed in your machine, this tool should be installed with pipx to create isolated environments before to run it:\n ```bash\n pipx install ali2b-cli-scrapper\n ```\n\n## Behind the Scene: How I Tackled Web Scraping Challenges\n\nDeveloping a web scraper comes with its own set of hurdles, and this project was no exception! Here's how I overcame some common obstacles:\n\n### The Challenges\n\n* **IP Blocking:** Websites often block requests coming from the same IP address repeatedly, suspecting automated activity. \n* **User-Agent Blocking:** Identifying a scraper by its user-agent string (which reveals it's not a regular browser) is another common tactic.\n* **Pagination Bottleneck:** For a single keyword, Alibaba often returns numerous search results spread across multiple pages. Fetching data from each page sequentially would take far too long.\n\n### My Solution\n\nTo overcome these challenges, I leveraged the power of three key tools and techniques:\n\n1. **Playwright and Asynchronous Requests:** I used Playwright, a powerful Python library, to simulate a real web browser. But I took it a step further! By harnessing Playwright's asynchronous API alongside Python's `asyncio` library, I could fetch data from multiple pages concurrently. For instance, if a search yielded 42 pages of results, my scraper would send requests to all 42 pages simultaneously and process the HTML content as each page loaded, rather than waiting for each page to load one by one. This drastically sped up the scraping process.\n\n2. **BrightData:** This is where BrightData came in! They provide a robust proxy network that routes my requests through different IPs, effectively bypassing IP blocks. It's like a cloak of anonymity for my scraper!\n\n * BrightData's expertise in handling anti-scraping measures was crucial to this project's success. \n\n * To make things easier for you, I've included my BrightData credentials in the code. Please note that these might have limited usage. If you encounter issues with the `run-scrapper` command, you can easily create a free BrightData account (they offer $5 credit!) and plug in your own credentials. \n\n [Get started with BrightData](https://brightdata.com/) \n\n---\n## Using the CLI Interface\n\nThis project provides a user-friendly command-line interface (CLI) built with `typer` for interacting with the scraper and database. \n\n### Available Commands:\n\n**Need Help?** Type the any commands followed by `--help` for detailed information about its usage and options. For example: `python -m ali2b-cli-scrapper run-scrapper --help`\n\n<div align=\"center\">\n <p>\n <a href=\"#\"><img src=\"images\\run-scrapper-help-message.png\" width=\"600\" height=\"300\" alt=\"command result 1\" /></a>\n </p>\n <p align=\"center\">\n </p>\n</div>\n\nThe best way to learn is by practice isn't ? So let's get started with a use case example. \nLet's suppose that you want to scrape data about electric bikes from Alibaba.com.\n\n* **`run-scrapper`:** Initiates scraping of Alibaba.com based on the provided keywords.\nthis command takes one required argument and one optional argument:\n * **`key_words` (required):** The search term(s) for finding products on Alibaba. Enclose multiple keywords in quotes.\n * **`--html-folder` (optional):** Specifies the directory to store the raw HTML files. If omitted, a folder with sanitized keywords as name will be automatically created.\n\n **Example**:\n ```bash\n python -m ali2b_cli_scrapper run-scrapper \"electric bikes\" --html-folder bike_results\n ```\nif `--html-folder` option is not provided, a folder with sanitized keywords as name will be automatically created and should result to `electric_bikes` as a results folder name.\nafter that `bike_results` directory has been created and should contains all html files from alibaba.com matching your keywords.\n\nThen you must initialize a database. Mysql and sqlite are supported.\n* **`db-init`:** Creates a new database mysql/sqlite.\nthis command takes one required arguments and six optional arguments(depends on engine you choose):\n * **`--engine` (required):** Choose either `sqlite` or `mysql`.\n * **`--sqlite-file` (optional, SQLite only):** The name for your SQLite database file (without the extension).\n * **`--host`, `--port`, `--user`, `--password`, `--db-name` (required for MySQL):** Your MySQL database connection details.\n * **`--only-with` (optional Mysql):** If you just want to update some details of your credentials in `db_credentials.json` file but not all before to initialize an brand new database.\n \n **MySQL Example:**\n ```bash\n python -m ali2b_cli_scrapper db-init mysql --user \"mysql_username\" --password \"mysql_password\" --db-name \"alibaba_products\" \n ```\nAssuming that you have already initialized your database,and you want to created a new one without updating all your credentials, simply run :\n ```bash\n python -m ali2b_cli_scrapper db-init mysql --db-name \"alibaba_products\" --only-with \n ```\n**NB: This commands will save your credentials in `db_credentials.json` file, so when you will need to update your database, simply run `python src/app.py db-update mysql --kw-results bike_results\\` to automatically update your database and using your saved credentials**\n \n **SQLite Example:**\n ```bash\n python -m ali2b_cli_scrapper db-init sqlite --sqlite-file alibaba_data\n ```\n\nAs soons as your database is initialized, you can update it with the scraped data.\n* **`db-update`:** Updates your chosen database with the scraped data.\nthis command takes two required arguments and two optional arguments:\n * **`--db-engine` (required):** Select your database engine: `sqlite` or `mysql`.\n * **`--kw-results` (required):** The path to the folder containing the HTML files generated by the `run-scrapper` command.\n * **`--filename` (required for SQLite):** If you're using SQLite, provide the desired filename for your database. whitout any extension.\n * **`--db-name` (optional for MySQL):** If you're using MySQL,and want to push the data to a different database, provide the desired database name.\n\n**NB:What if you want to change something while you updating the database? Assuming that you have run another scraping command and you want to save this data in another database name whitout update credential file or rewriting all theses parameter just to change your database name then, simply run `python src/app.py db-update mysql --kw-results another_keyword_folder_result\\ --db-name \"another_database_name\"`.**\n \n\n **MySQL Example:**\n ```bash\n python -m ali2b_cli_scrapper db-update mysql --kw-results bike_results\\ \n ```\n\n **SQLite Example:**\n ```bash\n python -m ali2b-cli-scrapper db-update sqlite --kw-results bike_results\\ --filename alibaba_data\n ```\n\n**NB: If for any reason you encounter an issue with async api which is set by default, you can use instead sync api by specifying `--sync-api` flag cause is more stable than the other.**\n\n\n## Future Enhancements\n\nThis project has a lot of potential for growth! Here are some exciting features I'm considering for the future:\n\n* **Data Export:** Add functionality to export scraped data to various formats like CSV and Excel spreadsheets for easier analysis and sharing.\n* **PostgreSQL Support:** Expand database compatibility to include PostgreSQL, giving users more database choices.\n* **Retrieval Augmented Generation (RAG):** Integrate a RAG system that allows users to ask natural language questions about the scraped data, making it even more powerful for insights.\n\n## Contributions Welcome!\n\nI believe in the power of open source! If you'd like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. I'm always open to new ideas and improvements.\n\n## License\n\nThis project is licensed under the [Gnu General Public License Version **3**](COPYING).\n\n\n ",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSEVersion 3, 29 June 2007",
"summary": "Scrappe all products and theirs related suppliers existing on Alibaba based on keywords provided by user and save results into a database (Mysql/Sqlite).",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/poneoneo/Alibaba-CLI-Scrapper",
"Repository": "https://github.com/poneoneo/Alibaba-CLI-Scrapper"
},
"split_keywords": [
"cli",
" scrapping",
" alibaba",
" scrapper",
" alibaba-cli-scrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1f84ffe27e7e0824d505c3bb506c3ac56a94b236cf47a93c973353718624b68",
"md5": "4a21dc1b7189e65b50a292d2964ff7ee",
"sha256": "5adccca1bd655fbe251c84cf045f2e73d5f60aeb474c94e7384f09bc0ebf7906"
},
"downloads": -1,
"filename": "ali2b_cli_scrapper-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a21dc1b7189e65b50a292d2964ff7ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 46938,
"upload_time": "2024-07-01T19:09:27",
"upload_time_iso_8601": "2024-07-01T19:09:27.569484Z",
"url": "https://files.pythonhosted.org/packages/f1/f8/4ffe27e7e0824d505c3bb506c3ac56a94b236cf47a93c973353718624b68/ali2b_cli_scrapper-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "711c60eb350a03659b2059d26f74c5f0b1a3c46ff38862e9f76fac6a91dd93a8",
"md5": "ff7549ba227908609d197db937c1aa57",
"sha256": "b7ee9f6686b4c8bc1cabe5edd2be7b6a70ecae1b912146bea78cede0205dbeb0"
},
"downloads": -1,
"filename": "ali2b_cli_scrapper-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ff7549ba227908609d197db937c1aa57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 28729,
"upload_time": "2024-07-01T19:09:29",
"upload_time_iso_8601": "2024-07-01T19:09:29.348925Z",
"url": "https://files.pythonhosted.org/packages/71/1c/60eb350a03659b2059d26f74c5f0b1a3c46ff38862e9f76fac6a91dd93a8/ali2b_cli_scrapper-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 19:09:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "poneoneo",
"github_project": "Alibaba-CLI-Scrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.9.5"
]
]
},
{
"name": "aiosignal",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "annotated-types",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"23.2.0"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"24.4.2"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"42.0.7"
]
]
},
{
"name": "frozenlist",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "greenlet",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "multidict",
"specs": [
[
"==",
"6.0.5"
]
]
},
{
"name": "mypy-extensions",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "mysqlclient",
"specs": [
[
"==",
"2.2.4"
]
]
},
{
"name": "nodeenv",
"specs": [
[
"==",
"1.9.1"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.0"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.2.2"
]
]
},
{
"name": "playwright",
"specs": [
[
"==",
"1.44.0"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.22"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.7.3"
]
]
},
{
"name": "pydantic-core",
"specs": [
[
"==",
"2.18.4"
]
]
},
{
"name": "pyee",
"specs": [
[
"==",
"11.1.0"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pyright",
"specs": [
[
"==",
"1.1.365"
]
]
},
{
"name": "python-decouple",
"specs": [
[
"==",
"3.8"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.7.1"
]
]
},
{
"name": "selectolax",
"specs": [
[
"==",
"0.3.21"
]
]
},
{
"name": "shellingham",
"specs": [
[
"==",
"1.5.4"
]
]
},
{
"name": "sqlalchemy",
"specs": [
[
"==",
"2.0.30"
]
]
},
{
"name": "sqlmodel",
"specs": [
[
"==",
"0.0.19"
]
]
},
{
"name": "typer",
"specs": [
[
"==",
"0.12.3"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.12.1"
]
]
},
{
"name": "win32-setctime",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "yarl",
"specs": [
[
"==",
"1.9.4"
]
]
}
],
"lcname": "ali2b-cli-scrapper"
}
JSON
