Merge branch 'main' into arithmetic-geometric-progressions-fibonacci-…

…sequence

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Report about bug
+title: ''
+labels: bug
+assignees: ''
+---
+
+## Description of bug
+
+<!-- Please provide a clear and concise description of the bug, including:
+- What you expected to happen
+- What actually happened
+- Steps to reproduce the issue -->
+
+## Your code
+
+<!--
+You can provide link to repository or specific file in this repository
+Or your code (if it's small)
+Please ensure you do not share any sensitive information such as API keys or passwords.
+-->
+
+## Versions
+
+### Python
+
+<!-- Type here your `python` version -->
+
+### `ufpy` and `requests`
+
+<!-- Please provide the version of `ufpy` and `requests` you're using -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: Discussions on GitHub
+    url: https://github.com/honey-team/ufpy/discussions
+    about: Ask your question in GitHub discussions
+  - name: Discord server
+    url: https://discord.honey-team.ru
+    about: Ask your question on our official Discord Server (verified custom domain)
+  - name: Telegram channel
+    url: https://tg.honey-team.ru
+    about: Ask your question on our official Telegram channel (in HoneyTeam Chat) (verified custom domain)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: To request a feature
+title: ''
+labels: new feature
+assignees: ''
+---
+
+## Description of new feature
+
+<!-- Type here description of your new feature -->
+
+## Use Case `(optional)`
+<!-- Describe the scenario or situation where this feature would be useful -->
+
+## Suggest solution `(optional)`
+
+<!-- If you want, type here solution of your new feature -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Description `(optional)`
+
+<!-- Type here description of what you made -->
+
+## TO-DO list `(optional)`
+
+<!-- Type here TO-DO list using checkboxes
+- [ ] Feature
+- [x] Made feature
+-->
+
+## Issue you want to close `(optional)`
+
+closes #<!-- type here id of issue you want to close -->

.gitignore

@@ -159,6 +159,9 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+# VSCode
+.vscode
+
 # Tests
 tests.py
 

README.md

@@ -1,2 +1,83 @@
-# ufpy
-Ufpy (Useful Python) - package for Python with some useful features
+<p align=center>
+    <picture>
+        <source
+            srcset="https://raw.githubusercontent.com/honey-team/ufpy/main/readme_assets/logo_d.svg"
+            media="(prefers-color-scheme: dark), (min-width: 200px)"
+        />
+        <source
+            srcset="https://raw.githubusercontent.com/honey-team/ufpy/main/readme_assets/logo_l.svg"
+            media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference), (min-width: 200px)"
+        />
+        <img src="https://raw.githubusercontent.com/honey-team/ufpy/main/readme_assets/logo.svg" width="200" alt="Logo" style="text-align: center" />
+    </picture>
+</p>
+
+<p align=center>
+    <a href="https://pypi.org/project/ufpy">
+        <img src="https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label&color=blue" alt="Pypi">
+    </a>
+    <a href="https://python.org">
+        <img src="https://img.shields.io/badge/3.12%2B-blue?logo=python&logoColor=white" alt="Python version">
+    </a>
+    <a href="https://honey-team.ru/ufpy-website">
+        <img src="https://img.shields.io/badge/docs-blue?logo=material%20for%20mkdocs&logoColor=white" alt="Docs">
+    </a>
+    <a href="https://pypi.org/project/pylint">
+        <img src="https://img.shields.io/badge/pylint-blue" alt="Pylint">
+    </a>
+    <a href="https://pypi.org/project/black">
+        <img src="https://img.shields.io/badge/black-blue" alt="Black">
+    </a>
+</p>
+
+Ufpy (Useful Python) - package for Python with some useful features which can help you!
+
+# Key features
+
+- Useful dict (UDict) for simplification working with dictionaries. [See more...](examples/udict.md)
+- Download GitHub's public repositories, its folders and files. [See more...](examples/github/download.md)
+- Some type alias and protocols
+- And more!
+
+# Installation
+
+## Install latest version
+
+To install `ufpy` with `pip` use this command in your shell
+```sh
+pip install ufpy
+```
+
+## Install specific version
+
+To install specific version of `ufpy` with `pip` use this command in your shell
+```sh
+# Example: install ufpy 0.2
+pip install ufpy==0.2
+```
+
+## Install dev version
+
+To install dev version with `pip` use this command in your shell
+```sh
+pip install git+https://github.com/honey-team/ufpy.git
+```
+
+# Contributing
+
+You can contribute to this project via [GitHub](https://github.com/honey-team/ufpy). Here's how:
+1. Fork the repository
+2. Create a new branch for your feature or bug fix
+3. Make your changes, following our [coding standards](/CONTRIBUTING.md/)
+4. Write tests for your changes
+5. Ensure all tests pass
+6. Submit a pull request with a clear description of your changes
+For more detailed guidelines, please see our [Contributing Guide](/CONTRIBUTING.md).
+
+If you want to contribute to docs website, fork [website repository](https://github.com/honey-team/ufpy-website) and open pull request!
+
+# Support
+
+If you have a problem or just have a question, open [discussion in GitHub](https://github.com/honey-team/ufpy/discussions). Also you can tell me your suggestions and ideas in this [discussions](https://github.com/honey-team/ufpy/discussions).
+
+Enjoy `ufpy`! I'd like to see that my project will be using in your projects. Bye! :)