# Fakepilot
[](https://github.com/phoenixsite/fakepilot/actions/workflows/python-app.yml)
[](https://pypi.org/project/fakepilot/)
[Trustpilot](https://www.trustpilot.com/) scrapping Python package.
Extract online business reviews and integrate it on your code.
It is based on [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/).
## Features
* Simple searching functionalitites.
* Support the selection of any country available in Trustpilot.
* Extraction of fine-grained data from business reviews.
* Use Trustpilot URLs or local file from where extract the information.
## Installation
[](https://pypi.org/project/fakepilot/)
fakepilot is available on Pypi. You can install fakepilot from it with
```bash
pip install fakepilot
```
To install fakepilot from the GitHub source, clone the repository with `git`:
```bash
git clone https://github.com/phoenixsite/fakepilot.git
```
Then, change your current directory to the one you cloned and install it with `pip`:
```bash
cd fakepilot
pip install .
```
## Usage
The function `search` can be used to mimic the search bar functionality
of Trustpilot. It limits the number of results and you can
indicate whether some reviews should be extracted for each company result.
For example, the following code search for two companies that match
the expression 'starbucks' and two of its reviews.
``` python
import fakepilot as fp
fp.search("starbucks", 2, with_reviews=True, nreviews=2)
```
All the Trustpilot country-specific sites can be used to make the queries.
For instance, the Norwegian Trustpilot site can be used:
``` python
fp.search("starbucks", 1, country="norge")
```
If it is required that all the results include a specific parameter, e.g.
the phone number of the company, you can specify it
in the `search` function:
```python
fp.search("starbucks", 1, False, 1, "phone", "norge")
```
Also, the information of a Trustpilot company page can be directly extracted
using ``get_company`` with a given URL or a local file.
The following block extracts ten reviews from the
specified URL:
```python
fp.get_company("https://www.trustpilot.com/review/www.starbucks.com", 10)
```
The following block extract the information and ten reviews from a local file:
```python
fp.get_company("my_file.html", True, 10)
```
## Documentation
[](https://fakepilot.readthedocs.io/en/latest/)
For a detail description of all the options you can visit the [fakepilot's
official documentation site](https://fakepilot.readthedocs.io/)
or you can build yourself
in ``docs`` with [Sphinx](https://www.sphinx-doc.org/en/master/):
```bash
cd docs
make html
```
## Warning
I strongly recommend using this scrapper with moderation and carefully.
Searching for multiple expressions in a short period of time can generate
a lot of requests and connections to the Trustpilot servers and may affect the
operation of the website. **Be careful, respectful and responsible with
scrappers online**.
Raw data
{
"_id": null,
"home_page": null,
"name": "fakepilot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "trustpilot, scrapping, beautifulsoup",
"author": null,
"author_email": "Carlos Romero Cruz <phoenixsitegit@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/2a/64/0d2e6ab64d58068619159defda85a484aca61acb925cd92f74869a35bfe8/fakepilot-0.0.3.tar.gz",
"platform": null,
"description": "# Fakepilot\n\n[](https://github.com/phoenixsite/fakepilot/actions/workflows/python-app.yml)\n[](https://pypi.org/project/fakepilot/)\n\n[Trustpilot](https://www.trustpilot.com/) scrapping Python package.\nExtract online business reviews and integrate it on your code.\nIt is based on [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/).\n\n## Features\n* Simple searching functionalitites.\n* Support the selection of any country available in Trustpilot.\n* Extraction of fine-grained data from business reviews.\n* Use Trustpilot URLs or local file from where extract the information.\n\n## Installation\n[](https://pypi.org/project/fakepilot/)\n\nfakepilot is available on Pypi. You can install fakepilot from it with\n\n```bash\npip install fakepilot\n```\n\nTo install fakepilot from the GitHub source, clone the repository with `git`:\n\n```bash\ngit clone https://github.com/phoenixsite/fakepilot.git\n```\n\nThen, change your current directory to the one you cloned and install it with `pip`:\n\n```bash\ncd fakepilot\npip install .\n```\n\n## Usage\nThe function `search` can be used to mimic the search bar functionality\nof Trustpilot. It limits the number of results and you can\nindicate whether some reviews should be extracted for each company result.\nFor example, the following code search for two companies that match\nthe expression 'starbucks' and two of its reviews.\n\n``` python\nimport fakepilot as fp\nfp.search(\"starbucks\", 2, with_reviews=True, nreviews=2)\n```\n\nAll the Trustpilot country-specific sites can be used to make the queries.\nFor instance, the Norwegian Trustpilot site can be used:\n\n``` python\nfp.search(\"starbucks\", 1, country=\"norge\")\n```\n\nIf it is required that all the results include a specific parameter, e.g.\nthe phone number of the company, you can specify it\nin the `search` function:\n\n```python\nfp.search(\"starbucks\", 1, False, 1, \"phone\", \"norge\")\n```\n\nAlso, the information of a Trustpilot company page can be directly extracted\nusing ``get_company`` with a given URL or a local file.\nThe following block extracts ten reviews from the\nspecified URL:\n\n```python\nfp.get_company(\"https://www.trustpilot.com/review/www.starbucks.com\", 10)\n```\n\nThe following block extract the information and ten reviews from a local file:\n\n```python\nfp.get_company(\"my_file.html\", True, 10)\n```\n\n## Documentation\n[](https://fakepilot.readthedocs.io/en/latest/)\n\nFor a detail description of all the options you can visit the [fakepilot's\nofficial documentation site](https://fakepilot.readthedocs.io/)\nor you can build yourself\nin ``docs`` with [Sphinx](https://www.sphinx-doc.org/en/master/):\n\n```bash\ncd docs\nmake html\n```\n\n## Warning\nI strongly recommend using this scrapper with moderation and carefully.\nSearching for multiple expressions in a short period of time can generate\na lot of requests and connections to the Trustpilot servers and may affect the\noperation of the website. **Be careful, respectful and responsible with\nscrappers online**.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Scrapping tool for Trustpilot",
"version": "0.0.3",
"project_urls": {
"Issues": "https://github.com/phoenixsite/fakepilot/issues",
"Repository": "https://github.com/phoenixsite/fakepilot"
},
"split_keywords": [
"trustpilot",
" scrapping",
" beautifulsoup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f79634d3058af91ce5836d3fdbede3444eb3c5c35ffe83b2f2733368788bdc24",
"md5": "6bb9654591cc7a6381de8d55a461aebf",
"sha256": "054deb03130d3252237982567f5ad53af3d84f15133cd141f08df08c41be23c5"
},
"downloads": -1,
"filename": "fakepilot-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bb9654591cc7a6381de8d55a461aebf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13313,
"upload_time": "2024-07-11T11:49:27",
"upload_time_iso_8601": "2024-07-11T11:49:27.618718Z",
"url": "https://files.pythonhosted.org/packages/f7/96/34d3058af91ce5836d3fdbede3444eb3c5c35ffe83b2f2733368788bdc24/fakepilot-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a640d2e6ab64d58068619159defda85a484aca61acb925cd92f74869a35bfe8",
"md5": "3b805f660293e1aa932950532ee19c4c",
"sha256": "ed12b661ebc8d1089cc527f9f77f488e605b9e01b00f7645f9ba98c02fa50793"
},
"downloads": -1,
"filename": "fakepilot-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "3b805f660293e1aa932950532ee19c4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15067,
"upload_time": "2024-07-11T11:49:29",
"upload_time_iso_8601": "2024-07-11T11:49:29.266898Z",
"url": "https://files.pythonhosted.org/packages/2a/64/0d2e6ab64d58068619159defda85a484aca61acb925cd92f74869a35bfe8/fakepilot-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 11:49:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phoenixsite",
"github_project": "fakepilot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fakepilot"
}
JSON
