webscraper/README.md

71 lines
1.1 KiB
Markdown
Raw Normal View History

2024-11-12 05:17:45 +01:00
# Web scraper 🔍
## Description
This project is a web scraper designed to extract data from websites.
2024-11-12 05:17:45 +01:00
## Features
☑️ Extracts data from web pages
2024-11-12 05:17:45 +01:00
## Usage
2024-11-12 05:17:45 +01:00
### With Docker
2024-11-12 05:17:45 +01:00
1. Clone the repository:
```bash
git clone https://git.wmi.amu.edu.pl/s500042/webscraper
2024-11-12 05:17:45 +01:00
```
2. Navigate to the project directory:
```bash
cd webscraper
```
3. Build the Docker image and run it using `start.py` script:
2024-11-12 05:17:45 +01:00
```bash
python start.py
```
On Mac, you'll have to use
2024-11-12 05:17:45 +01:00
```bash
python3 start.py
```
### Without Docker
1. Clone the repository:
```bash
git clone https://github.com/yourusername/webscraper.git
2024-11-12 05:17:45 +01:00
```
2. Install the required dependencies:
2024-11-12 05:17:45 +01:00
```bash
pip install -r requirements.txt
2024-11-12 05:17:45 +01:00
```
If you're on Arch Linux, you'll need to create a virtual environment.
Here's is a [Step by step guide](#) that will help you create it.
3. Run `run-with-no-docker.py` script:
```bash
python run-with-no-docker.py
```
2024-11-12 05:17:45 +01:00
On Mac you'll, need to use:
2024-11-12 05:17:45 +01:00
```bash
python3 run-with-no-dcoker.py
2024-11-12 05:17:45 +01:00
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.