Merge pull request #14 from r-liner/develop

Develop v0.7.7

Author: liner-exe

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @r-liner

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,78 @@
+name: 🐛 Bug Report
+description: Create a bug report
+labels:
+  - 'bug'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for taking the time to fill out this bug report!
+        ⚠️ If you do not use this template, we will simply close your issue.
+  - type: textarea
+    id: summary
+    attributes:
+      label: Description
+      description: >
+        Please provide a detailed description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: howtoreproduce
+    attributes:
+      label: How to Reproduce
+      description: >
+        Describe steps to reproduce the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: >
+        Describe what was expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: results
+    attributes:
+      label: Actual results
+      description: >
+        Describe what actually happened.
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Minimal code example
+      description: >
+        If applicable, provide a minimal code example to reproduce the bug.
+  - type: textarea
+    id: output
+    attributes:
+      label: Error messages
+      description: >
+        If applicable, provide any error messages or output related to the bug.
+  - type: input
+    id: os
+    attributes:
+      label: Operation System
+      description: >
+        Specify the operating system you are using.
+    validations:
+      required: true
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      description: >
+        Specify the version of Python you are using.
+    validations:
+      required: true
+  - type: input
+    id: nextcord
+    attributes:
+      label: Nextcord version
+      description: >
+        Specify the version of Nextcord you are using.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/r-liner/discord-commands-bot/discussions
+    about: Ask questions and discuss with others

.github/pull_request_template.md

@@ -1,9 +1,24 @@
-## Changes:
-- Added something..
-- Changed something..
-- Removed something..
-- Bug fixed..
-
-<!-- Describe changes by form above (Adding, deletion of something is also change)
-Also mention bug fixes if it fixed
-Remove this comment -->
+### Description
+Describe the changes in this pull request.
+
+### Related Issue
+- Mention the related issue here (if applicable).
+
+### Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Code quality improvements
+- [ ] Refactoring
+- [ ] Documentation update
+- [ ] Other (please specify)
+
+### Checklist
+- [ ] I have performed a self-review of my own code.
+- [ ] I have written unit tests and/or e2e tests.
+- [ ] My code follows the project's code style guidelines.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] My changes do not produce any new warnings or errors.
+- [ ] I have tested my changes.
+
+### Screenshots (if applicable)
+Please attach any relevant screenshots or images if applicable.

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Discord Commands Bot - Changelog
+- [v0.7.6](#v076-2024-01-19)
+- [v0.7.5](#v075-2023-10-01)
+
+
+## v0.7.6 (2024-01-19)
+
+### Tweaks
+- **change:** comments translated in `moderation.py` (ba8814fe3ce0e9a680652313f4cbe9e371d710a9)
+
+## v0.7.5 (2023-10-01)
+
+### Features
+- **main.py:** Added `if name main` construction
+
+### Chores
+**newfile:** `setup.py` for better setup the bot
+
+### Tweaks
+- **main.py:** switched to slash commands
+- **main.py:** translated one comment
+- **main.py:** added `if name main` construction
+- **tweak:** `start_win.bat` for better setup the bot
+- **tweak:** changed `config.ini.sample`

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 liner
+Copyright (c) 2022-2024 liner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,152 @@
-# discord-commands-bot [![CodeFactor](https://www.codefactor.io/repository/github/r-liner/discord-commands-bot/badge)](https://www.codefactor.io/repository/github/r-liner/discord-commands-bot)
+# Discord Commands Bot [![Code Factor](https://www.codefactor.io/repository/github/r-liner/discord-commands-bot/badge)](https://www.codefactor.io/repository/github/r-liner/discord-commands-bot)
+![GitHub Release](https://img.shields.io/github/v/release/r-liner/discord-commands-bot?style=for-the-badge&logo=github&color=efa94a)
+![GitHub issues](https://img.shields.io/github/issues-raw/r-liner/discord-commands-bot?style=for-the-badge)
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg?logo=python&logoColor=ffffff&style=for-the-badge)](https://www.python.org/downloads/)
+[![Nextcord Version](https://img.shields.io/badge/nextcord-2.4.2+-blue.svg?logo=pypi&logoColor=ffffff&style=for-the-badge)](https://pypi.org/project/nextcord/)
+![GitHub License](https://img.shields.io/github/license/r-liner/discord-commands-bot?style=for-the-badge&color=blue)
 
-## Choose your language / Выберите язык
+# Description
+An another yet Discord multipurposal bot written in Python.
+
+## Table of Contents
+- [Discord Commands Bot](#discord-commands-bot-code-factor)
+- [Description](#description)
+- [Table of Contents](#table-of-contents)
+- [Key Features](#key-features)
+- [Installation](#installation)
+  - [Prerequisites](#prerequisites)
+    - [API Keys](#api-keys)
+    - [Requirements](#requirements)
+  - [Installing - Self Hosting](#installing---self-hosting)
+- [Launch](#launch)
+- [Roadmap](#roadmap)
+- [Changelog](#changelog)
+- [Support](#support)
+- [Contribution](#contribution)
+- [Contact](#contact)
+- [License](#license)
+
+## Key Features
+- Async-await syntax
+- Slash commands partial-ready
+- Easy installation, setup
+- Use the same bot instance on multiple guilds
+- Regurarly updates
+
+## Installation
+### Prerequisites
+#### API Keys
+- Discord - https://discord.com/developers
+- Openweather (Optional) - https://openweathermap.org/api
+
+##### How to get discord token?
+1. Go to [Discord Developer Portal](https://discord.com/developers).
+2. Press **New Application**.
+
+    <details>
+        <summary>Hint</summary>
+        <img src='./assets/discord developer portal/setup_01.png' alt='setup_01.png'>
+    </details>
+3. Enter application name and press **Create**.
+    <details>
+        <summary>Hint</summary>
+        <img src='./assets/discord developer portal/setup_02.png' alt='setup_02.png'>
+    </details>
+4. Go to tab **Bot**.
+5. Reset and **Copy** bot token.
+    <details>
+        <summary>Hint</summary>
+        <img src='./assets/discord developer portal/setup_03.png' alt='setup_03.png'>
+    </details>
+
+Obtained keys must be entered while setup the bot through `setup.py`.
+
+#### Requirements
+- Installation of Python 3.8+ - https://www.python.org/downloads/
+
+##### Install nextcord:
+```sh
+# Linux/macOS
+python3 -m pip install -U nextcord
+
+# Windows
+pip install -U nextcord
+```
+##### Install dependencies:
+```
+pip install -r requirements.txt
+```
+
+### Installing - Self Hosting
+
+**Manual Installation**
+1. Complete [prerequisites](#prerequisites).
+2. [Download latest release](https://github.com/r-liner/discord-bot-ru/releases).
+3. Launch `setup.py` and complete setup procces.
+4. Done. Now you can launch the bot.
+
+**Installation via Git**
+1. Complete [prerequisites](#prerequisites).
+2. Clone repository using:
+```sh
+git clone https://github.com/r-liner/discord-commands-bot
+```
+3. Launch `setup.py` and complete setup procces.
+4. Done. Now you can launch the bot.
+
+## Launch
+You can run the bot through the `start_win.bat` for Windows
+or directly through the `main.py`. <br>
+During run the bot you must see:
+* Bot username (format: name#discrim).
+* Count of bot servers.
+
+## Roadmap
+- Feb - Migration to slash commands.
+- March - Code simplify.
+
+## Changelog
+You can find it [here]().
+
+## Support
+❓ If you have a **question** ask it [here](https://github.com/r-liner/discord-commands-bot/issues).
+
+🐛 If you found a **bug** have a look at the [issue list](https://github.com/r-liner/discord-commands-bot/issues/new/choose) before you [create a new issue](https://github.com/r-liner/discord-commands-bot/issues/new/choose). Please provide as much information as possible to help us understand and reproduce your issue.
+
+## Contribution
+If you would like to contribute to this project, fork repository, add your changes and then create pull request.
+Please ensure that you have thoroughly tested all your changes.
+
+Even if you`re not the programmer, you can contribute to this project by reporting bugs, requesting new features, fixing typos, etc.
+
+## Contact
+If you have a question regarding the project, [open new issue](https://github.com/r-liner/discord-commands-bot/issue/new/choose).
+
+If your request would contain confidentional information, [please send me an email](mailto:contact.liner999@gmail.com).
+
+## License
+[MIT](https://opensource.org/license/mit/)
 
-<img class="us" src="https://flagpedia.net/data/flags/w580/us.webp" width=30 align="center"> [English](https://github.com/r-liner/discord-commands-bot/blob/master/readme%60s/EN.MD)
-<br>
-<img src="https://flagpedia.net/data/flags/w580/ru.webp" width=30 align="center"> [Русский](https://github.com/r-liner/discord-commands-bot/blob/master/readme%60s/RU.MD)
-<br>
-<img src="https://flagpedia.net/data/flags/w580/fr.webp" width=30 align="center"> [Français](https://github.com/r-liner/discord-commands-bot/blob/master/readme%60s/FR.MD)
 <br>
-<img src="https://flagpedia.net/data/flags/w580/de.webp" width=30 align="center"> [Deutsch](https://github.com/r-liner/discord-commands-bot/blob/master/readme%60s/DE.MD)
+
+Copyright &copy; 2022-2024 [liner](https://github.com/r-liner)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[(Back to top)](#table-of-contents)