Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.48 KB

how_to_contribute.md

File metadata and controls

36 lines (24 loc) · 1.48 KB

Table of Contents

We Want You!

First and foremost, thank you for thinking about making Fundus better. We aim to tackle news scraping by using domain-specific parsers to achieve precise extraction. To handle this substantial workload, we rely on contributions from people like you.

What is Fundus

Fundus strives to be a lightweight, easy to use yet precise news-scraping library. At its core, Fundus is a parser library that focuses on handcrafted parsers instead of fully automated extraction. Consequently, to enable Fundus to parse news from specific domains, someone needs to create a parser tailored to that domain. Given the multitude of news domains, there are countless opportunities for contributions.

Setup Fundus

Before contributing to Fundus, ensure that you have installed Fundus in editable mode and are using the development requirements. If you haven't done this yet or are uncertain, follow these steps:

  1. Clone the repository.
  2. Optional but recommended: Create a virtual environment (.venv) or conda environment.
  3. Navigate to the root of the repository.
  4. Run pip install -e .[dev]

Contribution tutorials

  1. How to add a publisher

NOTE: If you run into any problems while contributing don't hesitate to ask questions in the issue tab.