{"id":17372884,"url":"https://github.com/nuztalgia/botstrap","last_synced_at":"2025-04-15T05:52:15.719Z","repository":{"id":49820537,"uuid":"515821083","full_name":"nuztalgia/botstrap","owner":"nuztalgia","description":"An easy-to-use utility toolbelt for Discord bots written in Python.","archived":false,"fork":false,"pushed_at":"2025-04-07T19:09:57.000Z","size":892,"stargazers_count":6,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T01:51:40.941Z","etag":null,"topics":["beginner-friendly","bot","bot-framework","botstrap","cli","command-line","discord","discord-bot","easy-to-use","encryption","python","python-3","python-library","secure","security","utilities"],"latest_commit_sha":null,"homepage":"https://botstrap.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuztalgia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-20T03:33:45.000Z","updated_at":"2024-01-12T18:33:34.000Z","dependencies_parsed_at":"2023-11-07T02:24:34.943Z","dependency_job_id":"1a9ab0c3-dc39-4063-9d64-d3ad5781e1ce","html_url":"https://github.com/nuztalgia/botstrap","commit_stats":{"total_commits":286,"total_committers":4,"mean_commits":71.5,"dds":"0.18181818181818177","last_synced_commit":"b46de6a8793db74e09aad404f55c7df46fdac4d5"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuztalgia%2Fbotstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuztalgia%2Fbotstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuztalgia%2Fbotstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuztalgia%2Fbotstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuztalgia","download_url":"https://codeload.github.com/nuztalgia/botstrap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654055,"owners_count":21140235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beginner-friendly","bot","bot-framework","botstrap","cli","command-line","discord","discord-bot","easy-to-use","encryption","python","python-3","python-library","secure","security","utilities"],"created_at":"2024-10-16T02:04:34.012Z","updated_at":"2025-04-15T05:52:15.704Z","avatar_url":"https://github.com/nuztalgia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n[![Botstrap: Logo (Link to Website)](https://raw.githubusercontent.com/nuztalgia/botstrap/main/docs/images/logo-192.png)](https://botstrap.readthedocs.io)\n\n# Botstrap\n\n[![Development Status](https://img.shields.io/pypi/status/botstrap)](https://pypi.org/project/botstrap/)\n[![Botstrap: Latest Version](https://img.shields.io/pypi/v/botstrap?label=latest%20version)](https://pypi.org/project/botstrap/)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/botstrap)](https://pypi.org/project/botstrap/)\n\u003cbr\u003e\n[![CodeQL Workflow](https://img.shields.io/github/actions/workflow/status/nuztalgia/botstrap/codeql.yml?branch=main\u0026label=codeQL\u0026logo=github)](https://github.com/nuztalgia/botstrap/actions/workflows/codeql.yml)\n[![Read the Docs](https://img.shields.io/readthedocs/botstrap?logo=read-the-docs\u0026logoColor=fff)](https://readthedocs.org/projects/botstrap)\n[![Tests Workflow](https://img.shields.io/github/actions/workflow/status/nuztalgia/botstrap/tests.yml?branch=main\u0026label=tests\u0026logo=pytest\u0026logoColor=fff\u0026logoWidth=13)](https://github.com/nuztalgia/botstrap/actions/workflows/tests.yml)\n\u003cbr\u003e\n[![CodeFactor: Code Quality](https://img.shields.io/codefactor/grade/github/nuztalgia/botstrap?label=codefactor\u0026logo=codefactor\u0026logoColor=fff\u0026logoWidth=12)](https://codefactor.io/repository/github/nuztalgia/botstrap)\n[![Codacy: Code Quality](https://img.shields.io/codacy/grade/6864639715f04899b62d3a4460eba83e?label=codacy\u0026\u0026logo=codacy)](https://app.codacy.com/gh/nuztalgia/botstrap)\n[![Codecov: Test Coverage](https://img.shields.io/codecov/c/github/nuztalgia/botstrap?logo=codecov\u0026logoColor=fff)](https://app.codecov.io/github/nuztalgia/botstrap)\n\nAn easy-to-use utility toolbelt for Discord bots written in Python. \u003cbr\u003e\n[**Read the docs »**](https://botstrap.readthedocs.io)\n\n\u003c/div\u003e\n\n## Overview\n\nDo you store your Discord bot token in [plaintext]? Don't get caught with your pants\ndown. Strap in!\n\n**Botstrap** is a ~~Python library~~ suit of power armor that perfectly fits your\nDiscord bot. It offers:\n\n- 🔐 **Secure encryption** and password protection to keep your bot tokens safe\n- 🤹 A straightforward way to **manage multiple tokens** and/or bot configurations\n- 🌈 An intuitive, colorful, and customizable **command-line interface** for your bot\n- 🤝 Out-of-the-box **compatibility** with all of the most popular Python [Discord\n  libraries]\n- ... and more to come!\n\n[plaintext]: https://en.wikipedia.org/wiki/Plaintext\n[discord libraries]: https://github.com/nuztalgia/botstrap/tree/main/examples/libraries\n\n## Installation\n\nPython **3.10** or higher is required. It's also generally a good idea to upgrade pip\n(`python -m pip install -U pip`).\n\n```sh\npip install -U botstrap\n```\n\nFor additional/alternative installation instructions, see the [documentation].\n\n[documentation]: https://botstrap.readthedocs.io/en/latest/getting-started/#installation\n\n## Quickstart\n\nComing soon! In the meantime, check out:\n\n- The [examples] directory\n- Starter [bot templates] for various Discord libraries\n- **And most importantly:** The extremely detailed [Botstrap API Reference]\n\n[examples]: https://github.com/nuztalgia/botstrap/tree/main/examples\n[bot templates]: https://github.com/nuztalgia/botstrap/tree/main/examples/libraries\n[botstrap api reference]: https://botstrap.readthedocs.io/en/latest/api/\n\n## Git Hooks\n\nAdding one or both of Botstrap's [pre-commit] hooks to your `git` workflow is an easy\nand seamless way to improve the security of your codebase. (If you're unfamiliar with\npre-commit, here's its [quickstart] guide. Highly recommend!)\n\nSee below for descriptions of the available hooks, and add the one(s) you like to your\n`.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/nuztalgia/botstrap\n  rev: 0.2.9\n  hooks:\n    - id: detect-discord-bot-tokens\n    - id: detect-encrypted-tokens\n```\n\n### 🕵️ `detect-discord-bot-tokens`\n\nThis hook checks the contents of your added/changed files every time you `git commit`,\nand raises an error if it finds any unencrypted bot tokens. It won't catch any plaintext\ntokens that you've `.gitignore`-d or already committed, but it _will_ prevent you from\naccidentally committing new ones.\n\n**Note:** This hook is especially useful for bots whose tokens aren't secured by the\nmain Botstrap library - **including bots written in languages other than Python!** ✨\n\n### 💂 `detect-encrypted-tokens`\n\nAlthough it isn't _quite_ as dangerous to commit your encrypted bot tokens, doing so is\nstill very much a security risk. This hook prevents that from happening by raising an\nerror if you try to `git commit` a file whose name matches the pattern used by\nBotstrap's encrypted token files. (**Hint:** Keep this hook happy by adding `*.key` to\nyour `.gitignore`.)\n\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[quickstart]: https://pre-commit.com/index.html#quick-start\n\n## Badges\n\nLet everyone know your Discord bot is secure by adding a badge to your repository's\n`README.md`:\n\n[![Botstrap: On](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Fbotstrap-on.json)](https://github.com/nuztalgia/botstrap)\n[![Botstrap: Enabled](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Fbotstrap-enabled.json)](https://github.com/nuztalgia/botstrap)\n[![Tokens: Encrypted](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Ftokens-encrypted.json)](https://github.com/nuztalgia/botstrap)\n[![Tokens: Secure](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Ftokens-secure.json)](https://github.com/nuztalgia/botstrap)\n[![Botstrap](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Fbotstrap.json)](https://github.com/nuztalgia/botstrap)\n\n```\n[![Botstrap](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnuztalgia%2Fbotstrap%2Fmain%2F.github%2Fbadges%2Fbotstrap-on.json)](https://github.com/nuztalgia/botstrap)\n```\n\nYou can replace `botstrap-on` in the above snippet with the text on one of the other\nbadges (e.g. `tokens-secure`).\n\nFor more granular customization options, check out the available style parameters on\n[shields.io](https://shields.io/#styles).\n\n## License\n\nCopyright © 2022 [Nuztalgia](https://github.com/nuztalgia). Released under the\n[Apache License, Version 2.0](https://github.com/nuztalgia/botstrap/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuztalgia%2Fbotstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuztalgia%2Fbotstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuztalgia%2Fbotstrap/lists"}