https://github.com/stephanlensky/hyacinth

A Discord bot to send notifications for marketplace (Craigslist, Facebook) postings based on complex matching rules.
https://github.com/stephanlensky/hyacinth

craigslist discord notifications python

Last synced: about 2 months ago
JSON representation

A Discord bot to send notifications for marketplace (Craigslist, Facebook) postings based on complex matching rules.

• Host: GitHub
• URL: https://github.com/stephanlensky/hyacinth
• Owner: stephanlensky
• License: agpl-3.0
• Created: 2020-06-21T22:05:05.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-18T01:12:24.000Z (about 1 year ago)
• Last Synced: 2023-12-18T02:25:37.950Z (about 1 year ago)
• Topics: craigslist, discord, notifications, python
• Language: Python
• Homepage: https://slensky.com/hyacinth
• Size: 1.92 MB
• Stars: 26
• Watchers: 5
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hyacinth 🦜

[![Documentation](https://img.shields.io/github/actions/workflow/status/stephanlensky/hyacinth/docs.yml?branch=main)](https://slensky.com/hyacinth)

[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue.svg)](http://mypy-lang.org/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

**Documentation:** https://slensky.com/hyacinth

## Overview

**Hyacinth** is a Discord bot which will automatically send you notifications for new listings or postings anywhere on the web, with out-of-the-box support for Craigslist and Facebook Marketplace.

Taking inspiration from the venerable [youtube-dl](https://youtube-dl.org/), Hyacinth provides a core interface for filtering listings and sending notifications while allowing new listing sources to be added using a flexible plugin system.

Hyacinth offers a number of advanced features for power-users, including:

- Complex filtering rules, including text-based filtering using arbitrary boolean rules

- Customizable polling intervals, allowing full control over how often the bot checks for new listings

- Search batching, reducing the number of times listing sources are polled for each search and allowing for more searches before hitting anti-bot measures

For more information and the user guide, please head over to the [documentation](https://slensky.com/hyacinth/).

## Local development

This application is built with [Docker](https://www.docker.com/), and the recommended local development flow makes use of the Docker integrations available for modern IDEs (such as [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview)). To run the local development container in the background, use the following `docker-compose` command:

```

docker-compose up -d devbox

```

Then attach to the container using your favorite IDE.

## Getting additional help

If you have a question, bug report, or want to make a general inquiry about the project, please create a new [GitHub issue](https://github.com/stephanlensky/hyacinth/issues/new). If you are having a problem with Hyacinth, please make sure to include your operating system, complete logs, and any additional information about your Hyacinth configuration that may be relevant.

Questions directed to any personal accounts outside of GitHub will be ignored.