Add justfile to run commands

Author: Chocobo1

.github/workflows/ci.yaml

@@ -34,55 +34,26 @@ jobs:
       - name: Install tools
         run: |
           pip install -r requirements_dev.txt
-          ./aux/fetch_aux.sh
 
       - name: Run tests
         if: matrix.python-version == '3.10' # avoid hammering the sites
         continue-on-error: true
-        run: |
-          pytest \
-            --showlocals \
-            tests/*.py
+        run: just test
 
-      - name: Check typings
-        run: |
-          mypy \
-            --strict \
-            engines/*.py \
-            tests/*.py
-          pyright \
-            engines/*.py \
-            tests/*.py
+      - name: Run type check
+        run: just check
 
       - name: Lint code
-        run: |
-          pyflakes \
-            engines/*.py \
-            tests/*.py
-          bandit \
-            --skip B101,B110,B310,B314,B405 \
-            engines/*.py \
-            tests/*.py
+        run: just lint
 
       - name: Format code
         run: |
-          # skipping E265, fixing it will break plugin usage on older qbt instances (< v4.1.2)
-          pycodestyle \
-            --ignore=E265,W503 \
-            --max-line-length=1000 \
-            --statistics \
-            engines/*.py \
-            tests/*.py
-          isort \
-             --check \
-             --diff \
-             --line-length 1000 \
-             engines/*.py \
-             tests/*.py
+          just format
+          just --fmt --unstable
+          git diff --exit-code
 
       - name: Build code
-        run: |
-          python -m compileall engines/*.py
+        run: just build
 
 
   zizmor:

README.md

@@ -1,12 +1,9 @@
 Search Plugins
 ===
-[![GitHub Actions CI Status](https://github.com/qbittorrent/search-plugins/workflows/CI/badge.svg)](https://github.com/qbittorrent/search-plugins/actions)
 
 This repository contains search plugins for the search feature in [qBittorrent](https://github.com/qbittorrent/qBittorrent).
 
-:warning: We removed support for Python 2. Please, upgrade to Python 3 to continue using the search function.
-
-Jackett search plugin is enabled by default but you have to install an external program to make it work. You can disable the Jackett search plugin or [install Jackett](https://github.com/qbittorrent/search-plugins/wiki/How-to-configure-Jackett-plugin).
+**Use the plugins and the websites they refer to at your own risk. You are personally responsible for following your country's copyright laws.**
 
 Most probably, you want to head over to the [wiki](https://github.com/qbittorrent/search-plugins/wiki):
 * [List of unofficial search plugins](https://github.com/qbittorrent/search-plugins/wiki/Unofficial-search-plugins)
@@ -16,8 +13,16 @@ Most probably, you want to head over to the [wiki](https://github.com/qbittorren
 * [How to install search plugins](https://github.com/qbittorrent/search-plugins/wiki/Install-search-plugins)
 * [New Torznab search engine](https://github.com/qbittorrent/search-plugins/wiki/New-Torznab-search-engine)
 
+## Contribute
+
 Everyone is welcome to submit PRs that fix problems or add new plugins.
 
 This repository isn't managed by the core team directly. Its purpose is to allow a place where 3rd party contributors can gather and submit their plugins.
 
-**Use the plugins and the websites they refer to at your own risk. You are personally responsible for following your country's copyright laws.**
+## News
+
+* 2020/08/19 \
+  We removed support for Python 2. Please, upgrade to Python 3 to continue using the search function.
+
+* 2020/04/26 \
+  We are going to remove support for Python 2 soon. Please upgrade to Python 3 to be prepared and get a better experience.

nova3/README.md

@@ -0,0 +1,48 @@
+nova3 Plugins
+===
+[![GitHub Actions CI Status](https://github.com/qbittorrent/search-plugins/workflows/CI/badge.svg)](https://github.com/qbittorrent/search-plugins/actions)
+
+## Development Workflow
+
+0. Prerequisite
+
+   Make sure you have [Python](https://www.python.org/) installed.
+
+1. Setup Development Environment
+
+   Note that it is recommended to setup a [virtual environment][venv_guide] for development.
+
+   ```shell
+   pip install -r requirements_dev.txt
+   ```
+
+   [venv_guide]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments
+
+2. Run tests
+
+   ```shell
+   just test
+   ```
+
+3. Run type check
+
+   ```shell
+   just check
+   ```
+
+4. Run static analyzer
+
+   ```shell
+   just lint
+   ```
+
+5. Apply formatting
+
+   ```shell
+   just format
+   ```
+
+## References
+
+* [How to write a search plugin](https://github.com/qbittorrent/search-plugins/wiki/How-to-write-a-search-plugin)
+* [justfile manual](https://just.systems/man/en/)

nova3/justfile

@@ -0,0 +1,53 @@
+# show available recipes to run
+default:
+    just --list
+
+# Run type check
+check files='engines/*.py tests/*.py': fetch_aux
+    mypy \
+        --strict \
+        {{ files }}
+    pyright \
+        {{ files }}
+
+# Byte-compile files
+build files='engines/*.py':
+    python \
+        -m compileall \
+        {{ files }}
+
+# Fetch auxiliary files
+[private]
+fetch_aux:
+    #!/usr/bin/sh
+    if [ ! -f aux/helpers.py ]; then
+        ./aux/fetch_aux.sh
+    fi
+
+# Apply formatting
+format files='engines/*.py tests/*.py':
+    # skipping E265, fixing it will break plugin usage on older qbt instances (< v4.1.2)
+    pycodestyle \
+        --ignore=E265,W503 \
+        --max-line-length=1000 \
+        --statistics \
+        {{ files }}
+    isort \
+        --check \
+        --diff \
+        --line-length 1000 \
+        {{ files }}
+
+# Run static analyzer
+lint files='engines/*.py tests/*.py':
+    pyflakes \
+        {{ files }}
+    bandit \
+        --skip B101,B110,B310,B314,B405 \
+        {{ files }}
+
+# Run tests
+test files='tests/*.py': fetch_aux
+    pytest \
+        --showlocals \
+        {{ files }}

nova3/requirements_dev.txt

@@ -5,3 +5,4 @@ pycodestyle
 pyflakes
 pyright
 pytest
+rust-just