https://github.com/kamfretoz/pururu
A Multi-Purpose bot written in Hikari + Lightbulb!
https://github.com/kamfretoz/pururu
discord discord-bots hikari-lightbulb hikari-py python
Last synced: 11 months ago
JSON representation
A Multi-Purpose bot written in Hikari + Lightbulb!
- Host: GitHub
- URL: https://github.com/kamfretoz/pururu
- Owner: kamfretoz
- License: wtfpl
- Created: 2021-12-21T12:25:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-14T11:48:26.000Z (11 months ago)
- Last Synced: 2025-07-14T15:00:45.297Z (11 months ago)
- Topics: discord, discord-bots, hikari-lightbulb, hikari-py, python
- Language: Python
- Homepage:
- Size: 9.47 MB
- Stars: 19
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
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]
[![MIT License][license-shield]][license-url]
PuruBot
A Multi-Purpose bot written with Hikari + Lightbulb!
Table of Contents
## About The Project
This is a Multi-Purpose Bot written in Python and built with Hikari and Lightbulb.
A project that serves as a way for me to learn Python Programming.
Feel free to explore it by yourself!
### Built With
* [`hikari`](https://github.com/hikari-py/hikari) - An opinionated, static typed Discord microframework for Python3 and asyncio that supports Discord's V10 REST API and Gateway.
* [`Lightbulb`](https://github.com/tandemdude/hikari-lightbulb/) - A flexible command framework designed to extend Hikari.
## Getting Started
To get the bot up and running, there are few steps that are need to be taken. Please follow these steps below carefully.
* You will need Python >= 3.8 so install it first!
* Install `screen` with `sudo apt install screen` or `sudo pacman -S screen` depending on your distro.
### Prerequisites
You will need to configure the bot with the `.env` file. This is needed to store some configuration data that are needed by the bot.
* As the bot uses few publicly available API (and Discord itself!), it needs a token to access them and you will have to provide them yourself, get the keys here:
* [Discord](https://discord.com/developers/applications)
* [OpenWeatherMap](https://openweathermap.org/api)
* [Currency API](https://currency.getgeoapi.com/)
* [Spotify](https://developer.spotify.com/dashboard/)
* You will also need a Lavalink nodes for music functionality. There are 2 options, either you self-host your own or you use the readily available Free Lavalink Nodes. Here are some recommendation:
* [Lavalink Hosting](https://lavalink.darrennathanael.com/)
* Configure your `.env` as you please and put your token here.
```sh
cd Pururu/
cp .env.example .env
nano .env
```
Further configuration can also be found at `utils/const.py`
### Installation
1. Clone the repository
```sh
git clone https://github.com/kamfretoz/Pururu.git
cd Pururu/
```
2. Create a Virtual Enviroment and activate it
```sh
python3 -m venv .venv
source .venv/bin/activate
```
3. Follow the steps from Prerequisites
4. Install the required dependencies
```sh
python3 -m pip install -r requirements.txt
```
5. Run the bot
```sh
chmod +x run.sh
./run.sh
```
## Running the bot (continued)
There are few notes in regards to run the bot:
* If you'd like to run the bot (Or when you want to restart it), you will have to re-activate the Virtual Environment if you haven't done so:
```sh
source .venv/bin/activate
./run.sh
```
* After you have successfully run the bot, you will have to Minimize the "screen" to let the bot run in the background.
* Press `CTRL + A, D` to Minimize the screen
* Type in `screen -r bot` to restore the screen
### Enjoy! :D
[contributors-shield]: https://img.shields.io/github/contributors/kamfretoz/Pururu.svg?style=for-the-badge
[contributors-url]: https://github.com/kamfretoz/Pururu/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/kamfretoz/Pururu.svg?style=for-the-badge
[forks-url]: https://github.com/kamfretoz/Pururu/network/members
[stars-shield]: https://img.shields.io/github/stars/kamfretoz/Pururu.svg?style=for-the-badge
[stars-url]: https://github.com/kamfretoz/Pururu/stargazers
[issues-shield]: https://img.shields.io/github/issues/kamfretoz/Pururu.svg?style=for-the-badge
[issues-url]: https://github.com/kamfretoz/Pururu/issues
[license-shield]: https://img.shields.io/github/license/kamfretoz/Pururu.svg?style=for-the-badge
[license-url]: https://github.com/kamfretoz/Pururu/blob/master/LICENSE