From be051a45ef46f27bd94341f1db42edf32180a288 Mon Sep 17 00:00:00 2001 From: bleudev Date: Sun, 25 Aug 2024 21:59:12 +0300 Subject: [PATCH 01/13] New README badges + test pylint badge --- .github/workflows/pylint.yml | 7 ++++++- README.md | 4 ++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index d8edaa7..5418328 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -39,4 +39,9 @@ jobs: python -m pip install -r ./requirements.txt - name: Analysing the code with pylint run: | - pylint $(git ls-files 'ufpy/*.py') --fail-under=7.0 \ No newline at end of file + pylint $(git ls-files 'ufpy/*.py') --fail-under=7.0 + - name: Update Pylint badge + uses: Silleellie/pylint-github-action@v2 + with: + lint-path: ufpy + python-version: 3.12 \ No newline at end of file diff --git a/README.md b/README.md index 0bed35b..75af225 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ +[![Pypi](https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label)](https://pypi.org/project/ufpy) +[![Python version](https://img.shields.io/badge/3.12%2B-blue?logo=python&logoColor=white)](https://python.org) +[![pylint]()](https://github.com/honey-team/ufpy) + # ufpy Ufpy (Useful Python) - package for Python with some useful features From 8ef628cba75fe2e09e8ace59615510610f956b4d Mon Sep 17 00:00:00 2001 From: bleudev Date: Sun, 25 Aug 2024 22:05:50 +0300 Subject: [PATCH 02/13] Bug fix permissions --- .github/workflows/pylint.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index 5418328..79f5c71 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -15,6 +15,9 @@ on: - 'requirements.txt' branches: - main + +permissions: + contents: write jobs: build: From 70b8cd1e9bc7caa24f3b976a44269329ebfe2a8a Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 25 Aug 2024 19:06:36 +0000 Subject: [PATCH 03/13] Updated pylint badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75af225..246a9bc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Pypi](https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label)](https://pypi.org/project/ufpy) [![Python version](https://img.shields.io/badge/3.12%2B-blue?logo=python&logoColor=white)](https://python.org) -[![pylint]()](https://github.com/honey-team/ufpy) +[![pylint](https://img.shields.io/badge/PyLint-7.04-orange?logo=python&logoColor=whitehttps://img.shields.io/badge/PyLint-7.04-orange?logo=python&logoColor=white) # ufpy Ufpy (Useful Python) - package for Python with some useful features From d03b07426d1bd38f6993977dcd8ef559c60083c8 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 26 Aug 2024 01:14:03 +0300 Subject: [PATCH 04/13] Logo + remove pylint mark --- .github/workflows/pylint.yml | 10 +--------- README.md | 22 ++++++++++++++++++++-- readme_assets/logo.svg | 4 ++++ readme_assets/logo_d.svg | 4 ++++ readme_assets/logo_l.svg | 4 ++++ 5 files changed, 33 insertions(+), 11 deletions(-) create mode 100644 readme_assets/logo.svg create mode 100644 readme_assets/logo_d.svg create mode 100644 readme_assets/logo_l.svg diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index 79f5c71..d8edaa7 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -15,9 +15,6 @@ on: - 'requirements.txt' branches: - main - -permissions: - contents: write jobs: build: @@ -42,9 +39,4 @@ jobs: python -m pip install -r ./requirements.txt - name: Analysing the code with pylint run: | - pylint $(git ls-files 'ufpy/*.py') --fail-under=7.0 - - name: Update Pylint badge - uses: Silleellie/pylint-github-action@v2 - with: - lint-path: ufpy - python-version: 3.12 \ No newline at end of file + pylint $(git ls-files 'ufpy/*.py') --fail-under=7.0 \ No newline at end of file diff --git a/README.md b/README.md index 246a9bc..fd37d45 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ -[![Pypi](https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label)](https://pypi.org/project/ufpy) +

+ + + + Logo + +

+ + + +[![Pypi](https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label&color=blue)](https://pypi.org/project/ufpy) [![Python version](https://img.shields.io/badge/3.12%2B-blue?logo=python&logoColor=white)](https://python.org) -[![pylint](https://img.shields.io/badge/PyLint-7.04-orange?logo=python&logoColor=whitehttps://img.shields.io/badge/PyLint-7.04-orange?logo=python&logoColor=white) +[![Docs](https://img.shields.io/badge/docs-blue?logo=material%20for%20mkdocs&logoColor=white)](https://honey-team.ru/ufpy-website) +[![Pylint](https://img.shields.io/badge/pylint-blue)](https://pypi.org/project/pylint) +[![Black](https://img.shields.io/badge/black-blue)](https://pypi.org/project/black) # ufpy Ufpy (Useful Python) - package for Python with some useful features diff --git a/readme_assets/logo.svg b/readme_assets/logo.svg new file mode 100644 index 0000000..3e7913a --- /dev/null +++ b/readme_assets/logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/readme_assets/logo_d.svg b/readme_assets/logo_d.svg new file mode 100644 index 0000000..8b94d53 --- /dev/null +++ b/readme_assets/logo_d.svg @@ -0,0 +1,4 @@ + + + + diff --git a/readme_assets/logo_l.svg b/readme_assets/logo_l.svg new file mode 100644 index 0000000..6326e58 --- /dev/null +++ b/readme_assets/logo_l.svg @@ -0,0 +1,4 @@ + + + + From 783b63e4cdb7e379ec2b09d505e2f5af052e3548 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 26 Aug 2024 01:33:26 +0300 Subject: [PATCH 05/13] Change logos + align badges --- README.md | 24 +++++++++++++++++------- readme_assets/logo.svg | 7 ++++--- readme_assets/logo_d.svg | 3 ++- readme_assets/logo_l.svg | 3 ++- 4 files changed, 25 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fd37d45..44552fb 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,23 @@

- - -[![Pypi](https://img.shields.io/pypi/v/ufpy?style=flat&logo=pypi&logoColor=white&label&color=blue)](https://pypi.org/project/ufpy) -[![Python version](https://img.shields.io/badge/3.12%2B-blue?logo=python&logoColor=white)](https://python.org) -[![Docs](https://img.shields.io/badge/docs-blue?logo=material%20for%20mkdocs&logoColor=white)](https://honey-team.ru/ufpy-website) -[![Pylint](https://img.shields.io/badge/pylint-blue)](https://pypi.org/project/pylint) -[![Black](https://img.shields.io/badge/black-blue)](https://pypi.org/project/black) +

+ + Pypi + + + Python version + + + Docs + + + Pylint + + + Black + +

# ufpy Ufpy (Useful Python) - package for Python with some useful features diff --git a/readme_assets/logo.svg b/readme_assets/logo.svg index 3e7913a..31c344c 100644 --- a/readme_assets/logo.svg +++ b/readme_assets/logo.svg @@ -1,4 +1,5 @@ - - - + + + + diff --git a/readme_assets/logo_d.svg b/readme_assets/logo_d.svg index 8b94d53..315b2b6 100644 --- a/readme_assets/logo_d.svg +++ b/readme_assets/logo_d.svg @@ -1,4 +1,5 @@ - + + diff --git a/readme_assets/logo_l.svg b/readme_assets/logo_l.svg index 6326e58..c21e3c1 100644 --- a/readme_assets/logo_l.svg +++ b/readme_assets/logo_l.svg @@ -1,4 +1,5 @@ - + + From 1c43990987f83a01ee80a2333b41287d729b51a5 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 26 Aug 2024 01:42:12 +0300 Subject: [PATCH 06/13] remove paragraph --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 44552fb..6b5fce8 100644 --- a/README.md +++ b/README.md @@ -30,5 +30,4 @@

-# ufpy Ufpy (Useful Python) - package for Python with some useful features From 2fbb3abf81c97b7cba7380925be1fda072c0587d Mon Sep 17 00:00:00 2001 From: bleudev Date: Fri, 30 Aug 2024 16:23:30 +0300 Subject: [PATCH 07/13] Key features + installation --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 6b5fce8..4612e4f 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,43 @@

Ufpy (Useful Python) - package for Python with some useful features + +# 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 +# Replace version with your specific version +pip install ufpy==version +``` + +## Install dev version + +To install dev version with `pip`: + +1. Clone this repository (you need to have installed `git`) +2. Install library as cloned code + +```sh +git clone https://github.com/honey-team/ufpy +cd ufpy +pip install . +``` + +After this you can remove `ufpy` directory + From e3101f83e2c383ff8c61b366cf649890a1148181 Mon Sep 17 00:00:00 2001 From: bleudev Date: Sat, 31 Aug 2024 22:46:32 +0300 Subject: [PATCH 08/13] Change `install dev version` command --- README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4612e4f..6dacaec 100644 --- a/README.md +++ b/README.md @@ -52,22 +52,14 @@ pip install ufpy To install specific version of `ufpy` with `pip` use this command in your shell ```sh -# Replace version with your specific version +# Replace `version` with your specific version pip install ufpy==version ``` ## Install dev version -To install dev version with `pip`: - -1. Clone this repository (you need to have installed `git`) -2. Install library as cloned code - +To install dev version with `pip` use this command in your shell ```sh -git clone https://github.com/honey-team/ufpy -cd ufpy -pip install . +pip install git+https://github.com/honey-team/ufpy.git ``` -After this you can remove `ufpy` directory - From 19c44ac10fc4f7e47189399f1e3852183d57fff6 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 2 Sep 2024 15:12:05 +0300 Subject: [PATCH 09/13] Final README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6dacaec..d3538c6 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@

-Ufpy (Useful Python) - package for Python with some useful features +Ufpy (Useful Python) - package for Python with some useful features which can help you! # Key features @@ -63,3 +63,14 @@ To install dev version with `pip` use this command in your shell pip install git+https://github.com/honey-team/ufpy.git ``` +# Contributing + +You can contribute to this project with [GitHub](https://github.com/honey-team/ufpy). Just fork this repository and open pull request! + +If you want to contribute to docs website, fork [website repository](https://honey-team/ufpy-website) and open pull request! + +# Support + +If you have a problem, open [discussion in GitHub](https://github.com/honey-team/ufpy/discussions). + +Enjoy `ufpy`! I'd like to see that my project will be using in your projects. Bye! :) From 01347e80d46e1ac87c845f780bacaec7fadc2788 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 2 Sep 2024 15:14:57 +0300 Subject: [PATCH 10/13] Update Support parapgraph --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d3538c6..4c3b68b 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,6 @@ If you want to contribute to docs website, fork [website repository](https://hon # Support -If you have a problem, open [discussion in GitHub](https://github.com/honey-team/ufpy/discussions). +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! :) From 1088dafb76fb8679f82700ecc9fd33c0801bc094 Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 2 Sep 2024 15:25:48 +0300 Subject: [PATCH 11/13] Bug fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c3b68b..4994e1d 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ pip install git+https://github.com/honey-team/ufpy.git You can contribute to this project with [GitHub](https://github.com/honey-team/ufpy). Just fork this repository and open pull request! -If you want to contribute to docs website, fork [website repository](https://honey-team/ufpy-website) and open pull request! +If you want to contribute to docs website, fork [website repository](https://github.com/honey-team/ufpy-website) and open pull request! # Support From 4e32b7cdad366b6894017437003b19a634d68abf Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 2 Sep 2024 15:37:06 +0300 Subject: [PATCH 12/13] Add example in specific version + fix links --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4994e1d..9448022 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@

- Pypi + Pypi - Python version + Python version - Docs + Docs Pylint @@ -52,8 +52,8 @@ pip install ufpy To install specific version of `ufpy` with `pip` use this command in your shell ```sh -# Replace `version` with your specific version -pip install ufpy==version +# Example: install ufpy 0.2 +pip install ufpy==0.2 ``` ## Install dev version From 1626f4656a85c783a0a485a52e4c166775d0840e Mon Sep 17 00:00:00 2001 From: bleudev Date: Mon, 2 Sep 2024 16:24:56 +0300 Subject: [PATCH 13/13] Add mini contributing guide --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9448022..5c7f466 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,14 @@ pip install git+https://github.com/honey-team/ufpy.git # Contributing -You can contribute to this project with [GitHub](https://github.com/honey-team/ufpy). Just fork this repository and open pull request! +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!