An open API service indexing awesome lists of open source software.

https://github.com/dev-lymar/xhamsterbot


https://github.com/dev-lymar/xhamsterbot

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

[![Python](https://img.shields.io/badge/Python-3.12-3776AB?style=flat&logo=Python&logoColor=yellow)](https://www.python.org/)
[![python-telegram-bot](https://img.shields.io/badge/Telegram--26A5E4?style=flat&logo=telegram&logoColor=white")](https://redis.io/)
[![Flake8](https://img.shields.io/badge/flake8-checked-blueviolet?style=flat)](https://flake8.pycqa.org/en/latest/)
[![isort](https://img.shields.io/badge/isort-checked-violet?style=flat)](https://pycqa.github.io/isort/)

# xhamsterbot-simplebot

## Project Description

***Bot idea:***

Have it send subscribers pictures of random kitties, or maybe not kitties🔞, to lift their spirits.
(This is a playful, educational project made as a joke.)

## Getting Started
**To get started with the project, follow these steps:**
1. Clone the repository and navigate to the project directory:

```sh
git clone https://github.com/dev-lymar/xhamsterbot.git
cd xhamsterbot
```
2. Configure .env
```sh
replace env.example with your data
```
3. Set Up a Virtual Environment on your machine

4. Install the required dependencies:
```sh
pip install -r requirements.txt
```
5. Run bot
```sh
python3 hamsterbot.py
```

## Contributing
If you would like to contribute to this project, please fork the repository and submit a pull request.
For major changes, please open an issue first to discuss what you would like to change.

## License
This project is licensed under the MIT License. See the LICENSE file for details.