diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6a7695c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml new file mode 100644 index 0000000..2e427bc --- /dev/null +++ b/.github/workflows/build-release.yml @@ -0,0 +1,50 @@ +name: Build Release + +on: + workflow_dispatch: + push: + branches: [ main ] + paths-ignore: + - .github/workflows/* + +jobs: + publish: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.11'] + + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: get version + id: version + uses: notiz-dev/github-action-json-property@release + with: + path: 'plugin.json' + prop_path: 'Version' + - run: echo ${{steps.version.outputs.prop}} + - name: Install libraries and dependencies + run: | + # Update pip + python -m pip install --upgrade pip + # Purge pip cache for clean platform change + pip cache purge + # Install requirements with windows platform dependency + pip install -r requirements.txt \ + --platform win_amd64 \ + --target ./lib \ + --only-binary=:all: + # Zip localized libraries and dependencies + zip -r Flow.Launcher.Plugin.RemovePaywall.zip . -x '*.git*' + - name: Publish + if: success() + uses: softprops/action-gh-release@v2 + with: + files: 'Flow.Launcher.Plugin.RemovePaywall.zip' + tag_name: "v${{steps.version.outputs.prop}}" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/Images/app.png b/Images/app.png index 3d1326f..c694f43 100755 Binary files a/Images/app.png and b/Images/app.png differ diff --git a/README.md b/README.md index c18a085..325789a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# Flow.Launcher.Plugin.RemovePaywall -Flow Launcher Python plugin to remove the Paywall from a specific URL. +# Flow Launcher Plugin - RemovePaywall drawing +This Flow Launcher Plugin simplifies accessing content and articles behind paywalls. It utilizes a selection of third-party services to bypass paywalls. Please note that the effectiveness of these services may vary depending on the website and the specific paywall implementation. This plugin has been tested with various news websites in English and German, including *The New York Times* and *heise online*. + +- **Effortless Access**: Simply enter or paste the URL of the paywalled content. +- **Quick Action**: Confirm with Enter key to initiate the paywall removal process. +- **Seamless Integration**: A new tab/window with the paywall-free content automatically opens in your default web browser. + +## Installation +1. Download and install [Flow Launcher](https://www.flowlauncher.com/). +2. Open the Flow Launcher settings +3. Go to the **Plugin Store** tab +4. Search for **'RemovePaywall'** +5. Click and Install **RemovePaywall** +6. Flow Launcher should restart automatically. If not, restart Flow Launcher manually +7. Re-open the Flow Launcher settings and head to the **Plugins** tab +8. Customize the [Settings](#settings) according to your configuration +9. Run the **'Save Settings'** command in Flow Launcher + +## Settings +|Setting|Default|Description| +|---|---|---| +|Action keyword|rp|Keyword to activate the plugin.| +|Remove Paywall Service|https://www.removepaywall.com/|URL/Service used to remove the Paywall from the article - options:
- https://www.removepaywall.com/
- https://archive.is/| +|Log Level|ERROR|The Log Level can be adjusted for error analysis. Normally not of interest for users.| +auswahlmöglichkeiten \ No newline at end of file diff --git a/main.py b/main.py index 37dc0d7..06e165b 100644 --- a/main.py +++ b/main.py @@ -7,7 +7,7 @@ sys.path.append(os.path.join(parent_folder_path, 'lib')) sys.path.append(os.path.join(parent_folder_path, 'plugin')) -from plugin.remove_paywall import Query +from plugin.query import Query from pyflowlauncher import Plugin if __name__ == "__main__": diff --git a/plugin/remove_paywall.py b/plugin/query.py similarity index 100% rename from plugin/remove_paywall.py rename to plugin/query.py