Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 1.37 KB

README.md

File metadata and controls

78 lines (49 loc) · 1.37 KB

Scrape Debian Wiki News

Scrape Debian Wiki News is a Python script that retrieves content from the Debian Wiki's News page and converts it into Markdown format.

Installation

  1. Clone the repository using Git:
    git clone git@github.com:VinneyJ/Debian-News-Scraper.git
  1. Navigate to the project folder.

  2. Create a virtual environment using virtualenv.

  3. Activate the virtual environment:

  • On macOS and Linux:
      source venv/bin/activate
    
  • On Windows:
      venv\Scripts\activate
    
  1. Install the required dependencies using pip:
    pip install -r requirements.txt
  1. Install the current directory as an editable package.
  pip install -e .

Usage

After setting up the project and installing the dependencies, you can run the script as follows:

    python3 src/scrape_debian.py

This will execute the script, scrape the Debian Wiki News page, and save the content in Markdown format.

Testing

You can run the provided tests to ensure the script's functionality:

    pytest tests -vv

Code Formatting

To format the code use

    black . && isort . 

Code Linting

To lint the code use

  pylint src/ tests/

Questions

If you have any questions or need assistance, please don't hesitate to reach out. Thank you for using Scrape Debian Wiki News!