Skip to content

arguellesm/faux

Repository files navigation

Faux

Faux is a tool aimed to reduce misinformation along the web. It analyzes texts and headlines to categorize them as fake news, clickbait articles or seemingly-normal-things.

Table of contents

Why and how

We've lately seen an increase in misleading information presented as true in the media. This project seeks an easy-access to reliable news and sources for everyone, no matter their previous knowledge or background.

Faux takes news and headlines as input and applies heuristics to classify them. Being a cloud service, it's constantly being updated and refined to achieve the best possible outcome.

Requirements

  • Python 3.8+.

Dependencies

Managed with Poetry, check out pyproject.toml.

Installation

Poetry

Poetry will manage and install dependencies, ensuring that your Faux built is ready to use. According to the official Poetry documentation, install with:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

This repository

Clone this repository and run:

cd faux
poetry install

This will install all dependencies.

Usage

Syntax check

You can check the syntax of every .py file under src with:

poetry shell
inv check

Running tests

Tests are located int test and we use Pytest to run them.

You can run them locally with:

inv test

Or you can run them inside a Docker container with:

inv docker

Read the docs!

Feel free to read a bit more about the project:

About

🦑 Factchecker API for headlines and articles

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published