https://github.com/ethanbaker/horus
My personal assistant bot, used to converse with GPT and custom modules, perform outreach, and be accessible through many implementations
https://github.com/ethanbaker/horus
Last synced: 11 months ago
JSON representation
My personal assistant bot, used to converse with GPT and custom modules, perform outreach, and be accessible through many implementations
- Host: GitHub
- URL: https://github.com/ethanbaker/horus
- Owner: ethanbaker
- License: gpl-3.0
- Created: 2024-05-18T00:15:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T01:03:21.000Z (almost 2 years ago)
- Last Synced: 2024-07-18T10:34:21.541Z (almost 2 years ago)
- Language: Go
- Homepage:
- Size: 150 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[](https://godoc.org/github.com/ethanbaker/horus)
Horus
A personal assistant bot, created for all my needs
Table of Contents
## About
Horus is my personal assistant bot for any and all purposes. The desire to create them came from a wish for a personal assistant that could tie into specific user information, such as emails, calendars, Notion databases, and more.
Horus currently has two main capacities: functioning as a GPT assistant (off of OpenAI's client and function calling, though with goals to eventually pivot to Llama3), and performing outreach to the user to give live updates/reminders.
These functions are achieved using implementations, which use basic Horus functionality in a specific user interface, such as a Discord bot, speech to text, or website. All communications occur through HTTP channels so the same base Horus runner can supply multiple implemenations with consistent information.
The `bot` directory contains a generic assistant template for Horus to run off of. Custom modules are utilized with OpenAI's tool functionality to handle custom functions. The main idea of this module is to take advantage of GPT assistants with easily maintainable, custom-made modules.
The `outreach` directory contains code used to reach out to the user unprompted, such as for reminders or alarms. Different types of 'messages' exist to contact the user and are defined as follows:
* **Dyanmic Messages**: used to check dynamic content repeatedly and send a message to the user (ex: check a schedule database every given interval and send the user a message when the start time lines up)
* **Static Messages**: used to message the user at a set, fixed time according to a cron string (ex: send a daily calendar digest every morning at 7:00)
* **Timed Messages**: used to message the user once after a given time (ex: send the user a reminder after 3 hours, or send the user a reminder on August 11th at 16:00)
The `implementations` directory contains different implementations of Horus. These implementations allow the user to interact with Horus, and can contain utility functions specific to the implementation type. Current implementations include
* Discord Bot
* Terminal Interface
### Built With
* [OpenAI GPT Models](https://platform.openai.com/docs/models)
* [Golang](https://go.dev/)
* [GORM](https://github.com/go-gorm/gorm)
* [Discord Go](https://github.com/bwmarrin/discordgo)
* [Notion API](https://developers.notion.com/)
## Getting Started
Horus is built by me, for me. A plethroa of generalized assistant bots exist to use for a wide variety of general purposes, but this bot was built with specific intent to provide me with specialized usecases. Because of this, Horus is not an "install right out of the box" kind of assistant. If you'd like to make use any of this functionality here, I'd recommend using the code as a template and custom-coding your own modules.
Here is a list of different sections of the code base and how they can be customized:
* `/bot`: add/modify custom modules according to the `/bot/template` directory. Implemented modules contain details about usage and credential needs
* `/outreach`: add/modify custom messages according to other examples
* `/implementations`: add/modify configuration setup to meet personal needs
## Usage
Horus can be used as a personal assistant through many implementations. Pictures of example usage will be located here in the future.
_For more examples, please refer to the [documentation][documentation-url]._
## Roadmap
- [x] Outreach
- [ ] Speech to text implementation
- [ ] Horus API
- [ ] API Wrapper
- [ ] Implementation API Usage
See the [open issues][issues-url] for a full list of proposed features (and known issues).
## Contributing
For issues and suggestions, please include as much useful information as possible.
Review the [documentation][documentation-url] and make sure the issue is actually
present or the suggestion is not included. Please share issues/suggestions on the
[issue tracker][issues-url].
For patches and feature additions, please submit them as [pull requests][pulls-url].
Please adhere to the [conventional commits][conventional-commits-url]. standard for
commit messaging. In addition, please try to name your git branch according to your
new patch. [These standards][conventional-branches-url] are a great guide you can follow.
You can follow these steps below to create a pull request:
1. Fork the Project
2. Create your Feature Branch (`git checkout -b branch_name`)
3. Commit your Changes (`git commit -m "commit_message"`)
4. Push to the Branch (`git push origin branch_name`)
5. Open a Pull Request
## License
This project uses the GNU General Public License.
You can find more information in the [LICENSE][license-url] file.
## Contact
Ethan Baker - contact@ethanbaker.dev - [LinkedIn][linkedin-url]
Project Link: [https://github.com/ethanbaker/horus][project-url]
## Acknowledgments
* [The Egyptian god Horus](https://en.wikipedia.org/wiki/Horus)
[contributors-shield]: https://img.shields.io/github/contributors/ethanbaker/horus.svg
[forks-shield]: https://img.shields.io/github/forks/ethanbaker/horus.svg
[stars-shield]: https://img.shields.io/github/stars/ethanbaker/horus.svg
[issues-shield]: https://img.shields.io/github/issues/ethanbaker/horus.svg
[license-shield]: https://img.shields.io/github/license/ethanbaker/horus.svg
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=555
[contributors-url]:
[forks-url]:
[stars-url]:
[issues-url]:
[pulls-url]:
[license-url]:
[linkedin-url]:
[project-url]:
[product-screenshot]: path_to_demo
[documentation-url]:
[conventional-commits-url]:
[conventional-branches-url]: