{"id":22144735,"url":"https://github.com/mohamedsaidsallam/cfdiscordnotificationbot","last_synced_at":"2026-04-16T03:31:21.796Z","repository":{"id":49633926,"uuid":"257980532","full_name":"MohamedSaidSallam/CFDiscordNotificationBot","owner":"MohamedSaidSallam","description":"A discord bot that allows you to set reminders on your server for upcoming codeforces rounds.","archived":false,"fork":false,"pushed_at":"2022-12-08T09:38:16.000Z","size":97,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T12:19:14.017Z","etag":null,"topics":["bot","codacy-badge","codeforces","codeforces-api","discord","discord-bot","discord-inv","discord-notifications","discord-py","discordbot","docker","docker-compose","notifications","pateron-badge","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MohamedSaidSallam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.MD","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-22T18:03:22.000Z","updated_at":"2021-08-06T21:24:59.000Z","dependencies_parsed_at":"2023-01-25T06:00:14.186Z","dependency_job_id":null,"html_url":"https://github.com/MohamedSaidSallam/CFDiscordNotificationBot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/MohamedSaidSallam/CFDiscordNotificationBot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MohamedSaidSallam%2FCFDiscordNotificationBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MohamedSaidSallam%2FCFDiscordNotificationBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MohamedSaidSallam%2FCFDiscordNotificationBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MohamedSaidSallam%2FCFDiscordNotificationBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MohamedSaidSallam","download_url":"https://codeload.github.com/MohamedSaidSallam/CFDiscordNotificationBot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MohamedSaidSallam%2FCFDiscordNotificationBot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31870506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["bot","codacy-badge","codeforces","codeforces-api","discord","discord-bot","discord-inv","discord-notifications","discord-py","discordbot","docker","docker-compose","notifications","pateron-badge","python3"],"created_at":"2024-12-01T22:31:06.018Z","updated_at":"2026-04-16T03:31:21.747Z","avatar_url":"https://github.com/MohamedSaidSallam.png","language":"Python","funding_links":["https://www.patreon.com/user?u=35000497"],"categories":[],"sub_categories":[],"readme":"# CF Discord Notification Bot\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"resources/CFN Icon.png\" alt=\"CFN Icon\" height=\"256\" width=\"256\"/\u003e\n\u003c/p\u003e\n\n[![Codacy Badge][codacy_badge]][codacy_link]\n[![License][license-image]][license-url]\n[![GitHub Release][github_release_badge]][github_release_link]\n[![Donate][pateron_badge]][pateron_link]\n[![Top.gg][top_gg_badge]][top_gg_link]\n[![Support Discord][discord_badge]][discord_inv]\n\nA discord bot that allows you to set reminders on your server for upcoming [codeforces][codeforces] rounds.\n\n## Features\n\nTo get the full list of commands type `;help` after adding the bot to the server.\n\n### Upcoming Contests\n\nUse `;upcoming` to get the upcoming contest on codeforces.\n\n![Upcoming_Example](resources/readme/Upcoming_Example.jpg)\n\n### Contest Notifications\n\nUse `;rfn @ROLE_TO_NOTIFIY` to register a channel for notifications.\n\n![Register Example](resources/readme/Register_Example.jpg)\n\n![Notification Example](resources/readme/Notification_Example.jpg)\n\n## Running the code\n\nYou can run the code using any of the following methods.\n\n### Venv\n\nInstall the required python modules (perferably in a virtual env) to be able to run the bot.\n\n``` bash\nPython -m venv venv\nvenv\\Scripts\\activate.bat\nPip install -r requirements.txt\n```\n\nThen copy the `.env.example` file and rename it to `.env` and fill in the appropriate values.\n\nRun the bot using the followingL\n\n```bash\npython -m CFDiscordNotificationBot\n```\n\n### Docker\n\nFirst make sure u have docker installed. Build the image from the dockerfile then run an container using the following commands.\n\n```bash\ndocker build -t cfnbot:latest .\ndocker run --rm -d -v CFNdata:/usr/src/app/Data/ --name CFN cfnbot:latest\n```\n\nTo stop the container:\n\n```bash\ndocker stop CFN\n```\n\n### Docker-compose\n\nFirst make sure u have docker compose installed. Run the following command to start the container.\n\n```bash\ndocker-compose up\n```\n\nUse ``--build`` if there has been a change to the Dockerfile.\n\n```bash\ndocker-compose up --build\n```\n\nTo stop the container:\n\n```bash\ndocker-compose down\n```\n\nIf you to use the same volume as docker change the volume part of docker-compose.yml to:\n\n```yaml\nvolumes:\n    CFNdata:\n        external: true\n```\n\n## Built With\n\n* [VS Code](https://code.visualstudio.com/) - Editor\n* [PyCharm](https://www.jetbrains.com/pycharm/) - Editor\n* [Photopea](https://www.photopea.com/) - Image editor\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\n[SemVer](http://semver.org/) was used for versioning. For the versions available, see the [tags on this repository](https://github.com/TheDigitalPhoenixX/CFDiscordNotificationBot/tags). For the Changelog see the [CHANGELOG](CHANGELOG.MD/) file.\n\n## Authors\n\n* **Mohamed Said** - [TheDigitalPhoenixX](https://github.com/TheDigitalPhoenixX)\n* **Sameh Amnoun** - [SamehAmnoun](https://github.com/SamehAmnoun)\n\nSee also the list of [contributors](CONTRIBUTORS.md) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n## Acknowledgments\n\n* [README.md Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)\n\n[license-image]: https://img.shields.io/badge/License-MIT-brightgreen.svg\n[license-url]: https://opensource.org/licenses/MIT\n\n[codeforces]: https://codeforces.com/\n\n[github_release_badge]: https://img.shields.io/github/v/release/TheDigitalPhoenixX/CFDiscordNotificationBot.svg?style=flat\n[github_release_link]: https://github.com/TheDigitalPhoenixX/CFDiscordNotificationBot/releases\n\n[top_gg_badge]: https://img.shields.io/badge/Add%20to%20your%20server-Top.gg-7289da\n[top_gg_link]: https://top.gg/bot/702589426487918733\n\n[codacy_badge]: https://api.codacy.com/project/badge/Grade/66e0a4c4474c41bf86a9463b805b94a3\n[codacy_link]: https://www.codacy.com/manual/OrganizationX/CFDiscordNotificationBot?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=TheDigitalPhoenixX/CFDiscordNotificationBot\u0026amp;utm_campaign=Badge_Grade\n\n[pateron_badge]: https://img.shields.io/badge/Patreon-support-f96854.svg?style=flat\n[pateron_link]: https://www.patreon.com/user?u=35000497\n\n[discord_badge]: https://discordapp.com/api/guilds/707807869650599947/widget.png\n[discord_inv]: https://discord.gg/qVxjDDd\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedsaidsallam%2Fcfdiscordnotificationbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohamedsaidsallam%2Fcfdiscordnotificationbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedsaidsallam%2Fcfdiscordnotificationbot/lists"}