https://github.com/shinshidevs/oleg

Service bot for "Shinshi Hub"
https://github.com/shinshidevs/oleg

crescent hikari python shinshihub

Last synced: about 1 month ago
JSON representation

Service bot for "Shinshi Hub"

• Host: GitHub
• URL: https://github.com/shinshidevs/oleg
• Owner: ShinshiDevs
• License: mit
• Created: 2023-11-14T19:45:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-21T07:57:53.000Z (10 months ago)
• Last Synced: 2024-02-21T08:44:13.497Z (10 months ago)
• Topics: crescent, hikari, python, shinshihub
• Language: Python
• Homepage: https://dsc.gg/shinshi
• Size: 62.5 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!WARNING]

> Oleg has been deprecated since September 7, 2024.



  


 Oleg

  
Service bot for Shinshi Hub, a support server. A bit similar to Shinshi, but much weaker in structure and content, but also serves as a good template for your future bot.


  


    

      

    

    

    	

    

    

    	

    

    

	

    

  


### References

- [Changelog](CHANGELOG.md)

- [Support](https://dsc.gg/shinshi)

### Contribution

Any contributors are welcome, but please respect these rules:

- Clear commit messages.

- Refactor the code before publishing with ruff.

  

  `poetry init --dev-dependency` to install development packages.

- In the commit description, state as much as possible, so we understand what you want to do.

Good luck! 🤝

### `Docker` In order to run the bot you need to

- Put all the necessary data in your `.env` file.

- Run the bot with `docker run -it $(docker build -q .)`.

### `poetry` In order to run the bot you need to

- Install Python (recommend [3.11](https://www.python.org/downloads/release/python-3116/))

- Install poetry. [Instructions](https://python-poetry.org/docs/#installing-with-the-official-installer)

- Go to the project directory and type `poetry init`. 

- Run the bot with `poetry run python3 -OO -m oleg`

> [!WARNING]  

> This way is not recommended.