Miscellaneous and Resources

Misc. Info

  • Enoch Bot is hosted on a free tier AWS EC2 instance

    • Rebecca has access to this

  • Programming style

    • Use flake8 and black

    • Make your code readable by others

      • Write comments when appropriate

      • Name variables, classes, and methods appropriately

    • Include docstrings for all classes and methods (if it's not obvious)

      • Exception: Docstrings are required for all commands since the contents of the docstring is used for the command's help text

  • Sensitive information (e.g. bot tokens, credentials, secrets, passwords, etc.)

    • Sensitive info should never be published publicly. For example, bot tokens should never be pushed to GitHub.

    • To share sensitive info, use One Time Secret

  • Branches vs Tags: Note that on the Enoch Bot GitHub repository, some branches and tags have very similar names (e.g. branch 2.2.0 and tag v2.2.0).

    • Note that branches won't contain "v" in front of the version number. The branches are automatically created by GitBook to manage the different variants of the documentation.

    • On the other hand, tags do contain "v" in front of the version number. Git commits are manually tagged based on changes made in that version.

Resources

Python

SQL

Discord

Google Sheets

Git & GitHub

AWS

Heroku

Other

Last updated