Git Product home page Git Product logo

ipn-lunch-menu-bot's Introduction

IPN Lunch Menu Bot

GitHub last commit GitHub issues GitHub pull requests GitHub

Overview

IPN Lunch Menu Bot is an automated script that fetches the weekly lunch menu from IPN's bar, processes it using ChatGPT, and posts the formatted menu to a specified Slack channel every Monday.

Features

  • Automated Image Fetching: Downloads the weekly menu image from a specified Facebook URL.
  • Image Processing with ChatGPT: Uses OpenAI's ChatGPT to extract and format the menu.
  • Slack Integration: Posts the formatted menu to a designated Slack channel.
  • Scheduled Execution: Runs every Monday using GitHub Actions.

Getting Started

Prerequisites

  • Python 3.10.x
  • GitHub account
  • Slack workspace and API token
  • OpenAI API key

Installation

  1. Clone the Repository

    git clone https://github.com/yourusername/ipn-lunch-menu-bot.git
    cd ipn-lunch-menu-bot
  2. Install Dependencies

    pip install -r requirements.txt
  3. Add API Keys to GitHub Secrets

    • OpenAI API Key: OPENAI_API_KEY
    • Slack API Token: SLACK_API_TOKEN

Usage

The script is designed to run automatically every Monday via GitHub Actions. To trigger the workflow manually, you can use the workflow_dispatch event in GitHub Actions.

Configuration

  • Image URL: Update the URL of the menu image in the menu_publisher.py script.
  • Slack Channel: Update the Slack channel ID in the menu_publisher.py script.

Contributing

Contributions are welcome! Please see our contributing guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Contact

If you have any questions, feel free to open an issue or contact me at @rjvitorino.

ipn-lunch-menu-bot's People

Contributors

rjvitorino avatar

Stargazers

Pedro Machado Santa avatar

Watchers

 avatar

ipn-lunch-menu-bot's Issues

Add License

Choose and add a license to the repository.

Write Unit Tests

Write unit tests for the functions to ensure reliability and correctness.

Integrate Slack API

Set up Slack API integration to post the formatted menu into a specified Slack channel.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.