{"id":43513647,"url":"https://github.com/hypergonial/arc-template","last_synced_at":"2026-02-03T13:17:14.027Z","repository":{"id":215237722,"uuid":"738415804","full_name":"hypergonial/arc-template","owner":"hypergonial","description":"A template to start creating a bot using hikari-arc.","archived":false,"fork":false,"pushed_at":"2024-03-15T14:34:41.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"gateway","last_synced_at":"2024-05-01T13:54:38.069Z","etag":null,"topics":["discord","discord-bot","hikari","hikari-arc","hikari-py","python","template","template-project"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypergonial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2024-01-03T07:13:22.000Z","updated_at":"2024-01-04T22:50:35.000Z","dependencies_parsed_at":"2024-03-13T14:38:16.213Z","dependency_job_id":null,"html_url":"https://github.com/hypergonial/arc-template","commit_stats":null,"previous_names":["hypergonial/arc-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/hypergonial/arc-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Farc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Farc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Farc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Farc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypergonial","download_url":"https://codeload.github.com/hypergonial/arc-template/tar.gz/refs/heads/gateway","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Farc-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29046503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["discord","discord-bot","hikari","hikari-arc","hikari-py","python","template","template-project"],"created_at":"2026-02-03T13:17:13.204Z","updated_at":"2026-02-03T13:17:14.015Z","avatar_url":"https://github.com/hypergonial.png","language":"Python","readme":"# arc-template\n\nA template to start creating a bot using hikari-arc. To see a REST version of this template, see the [`rest` branch](https://github.com/hypergonial/arc-template/tree/rest) of this repository.\n\n## Setting up\n\nCreate your repository using this template, clone/download it, then install all requirements:\n\n```sh\npip install -r requirements.txt -r dev_requirements.txt\n```\n\nThis will install:\n\n- [hikari-arc](https://github.com/hypergonial/hikari-arc) and all it's dependencies\n- [python-dotenv](https://github.com/theskumar/python-dotenv) to handle `.env` files\n- [ruff](https://github.com/astral-sh/ruff) a Python formatter and linter to help keep your code tidy\n- [pyright](https://github.com/microsoft/pyright) a Python typechecker to ensure correctness \u0026 type-safety\n- [nox](https://github.com/wntrblm/nox) a Python session runner to automate running the previous two tools\n\n## Learning `arc`\n\n- [Documentation](https://arc.hypergonial.com)\n- [Examples](https://github.com/hypergonial/hikari-arc/tree/main/examples)\n- [Discord Server](https://discord.gg/hikari)\n\n## Running the bot\n\nTo run the bot, run the following command in the project folder:\n\n```sh\npython3 -m src\n# On Windows you may need to do:\npy -m src\n```\n\n## Tooling\n\n### nox\n\n`nox` is a tool that can set up \u0026 run automated sessions. This template ships with the following session:\n\n`format_fix` - Run `ruff` to format \u0026 fix code (where possible) - default\n`format` - Run `ruff` to check for formatting \u0026 code correctness issues\n`pyright` - Run `pyright` to typecheck the code - default\n\nTo run a nox session, use `nox -s session_name`, so for example, to run `pyright`, use `nox -s pyright`.\nYou can also run the default set of sessions using `nox`.\n\n### Configuration\n\nAll of the tooling is configured using [`pyproject.toml`](https://github.com/hypergonial/arc-template/blob/gateway/pyproject.toml), see that file for more information!\n\n### Editor support\n\n#### VS Code\n\nIf you're using **Visual Studio Code**, you should automatically **get a prompt** when you first open the project to install\nrecommended extensions. The recommended extensions include:\n\n- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Python Language Support\n- [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) - Run ruff while you edit!\n- [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) - Generate new docstrings\n- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - Respect `.editorconfig`\n- [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) - `.toml` file support\n\nInstalling these will make your developer experience better, as pyright \u0026 ruff will be able to run on your code while you edit it!\n\n\u003e If you've dismissed the prompt, you can see \u0026 install the recommended extensions by searching for `@recommended` in the Extensions panel.\n\nIn addition, you can run `nox` using the shortcut `Ctrl` + `Shift` + `B`.\n\n#### PyCharm\n\nPyCharm should respect `.editorconfig` out of the box. Unfortunately I'm not aware of any good extensions that would allow it to run `ruff` while code\nis being edited. You can use `nox` for this purpose as a placeholder.\n\n#### Other editors\n\nIf you'd like to see explicit support for more editors in this template, please open a [pull request](https://github.com/hypergonial/arc-template/pulls).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypergonial%2Farc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypergonial%2Farc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypergonial%2Farc-template/lists"}