/KoichiBot

Python Bot

Primary LanguagePython

KoichiBot (workingProject).

1. πŸ—οΈ Project Structure


🧒 baseline documents/folders

  • πŸ“„ bot.py: Change this file and add here the code for your bot.
  • πŸ“ resources: Add into this folder files to be used with your bot such as images, spreadsheets and etc.
  • πŸ“„ VERSION: Change the content of this file when updating the version of your bot. It is recommended to use versions in the format X.Y. E.g. 1.0, 1.1, 2.5, 3.10.

baseline naming scheme

🌳 ROOT FOLDER ️

  • πŸ“„β”œβ”€β”€ MANIFEST.in <- This file defines the content of the package such as images.
  • πŸ“„β”œβ”€β”€ README.md <- Simple README file for your bot project.
  • πŸ“„β”œβ”€β”€ VERSION <- This file defines the Bot package version.
  • πŸ—ƒοΈβ”œβ”€β”€ botPython <- Main module for your Bot package.

πŸ—ƒοΈbotPython

  • πŸ“„β”œβ”€β”€ init.py
  • πŸ“„β”œβ”€β”€ main.py <- Entrypoint for the module. You don't need to bother with this file.
  • πŸ“„β”œβ”€β”€ bot.py <- Module for your bot code. Here is where you will develop your bot.
  • πŸ“β””β”€β”€ resources <- Folder containing resources useful for the Bot.
  • πŸ“„β”œβ”€β”€ build.bat <- Batch script to generate the package
  • πŸ“„β”œβ”€β”€ build.sh <- Shell script to generate the package
  • πŸ“„β”œβ”€β”€ requirements.txt <- File describing the python dependencies for your Bot.
  • πŸ“„β””β”€β”€ setup.py <- Setup file for the package.

2. 🎨Design Patterns


security + encryption