Metadata-Version: 2.1
Name: feedcrawler
Version: 14.1.3
Summary: Automating JDownloader Downloads (German!)
Home-page: https://github.com/rix1337/FeedCrawler
Author: rix1337
Author-email: 
License: UNKNOWN
Description: # FeedCrawler
        
        <img src="https://raw.githubusercontent.com/rix1337/FeedCrawler/master/feedcrawler/web/public/favicon.ico" data-canonical-src="https://raw.githubusercontent.com/rix1337/FeedCrawler/master/feedcrawler/web/public/favicon.ico" width="64" height="64" />
        
        FeedCrawler automatisiert bequem das Hinzufügen von Links für den JDownloader.
        
        [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rix1337/FeedCrawler/Release%20Artifacts)](https://github.com/rix1337/FeedCrawler/actions/workflows/CreateRelease.yml)
        [![GitHub stars](https://img.shields.io/github/stars/rix1337/FeedCrawler.svg)](https://github.com/rix1337/FeedCrawler/stargazers)
        [![GitHub all releases](https://img.shields.io/github/downloads/rix1337/feedcrawler/total?label=github%20downloads)](https://github.com/rix1337/FeedCrawler/releases)
        
        [![PyPI](https://img.shields.io/pypi/v/feedcrawler?label=pypi%20package)](https://pypi.org/project/feedcrawler/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/feedcrawler?label=pypi%20downloads)](https://pypi.org/project/feedcrawler/#files)
        
        [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/rix1337/docker-feedcrawler?label=docker%20image&sort=semver)](https://hub.docker.com/r/rix1337/docker-feedcrawler/tags)
        [![Docker Pulls](https://img.shields.io/docker/pulls/rix1337/docker-feedcrawler)](https://hub.docker.com/r/rix1337/docker-feedcrawler/)
        
        [![GitHub license](https://img.shields.io/github/license/rix1337/FeedCrawler.svg)](https://github.com/rix1337/FeedCrawler/blob/master/LICENSE.md)
        [![Python 3 Backend](https://img.shields.io/badge/backend-python%203-blue.svg)](https://github.com/rix1337/FeedCrawler/tree/master/feedcrawler)
        [![Vue.js 3 Frontend](https://img.shields.io/badge/frontend-vue.js%203-brightgreen.svg)](https://github.com/rix1337/FeedCrawler/tree/master/feedcrawler/web)
        [![GitHub last commit](https://img.shields.io/github/last-commit/rix1337/FeedCrawler)](https://github.com/rix1337/FeedCrawler/commits/master)
        [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/rix1337/feedcrawler)](https://github.com/rix1337/FeedCrawler/graphs/commit-activity)
        [![Lines of code](https://img.shields.io/tokei/lines/github/rix1337/FeedCrawler)](https://github.com/rix1337/FeedCrawler/pulse)
        
        [![Github Sponsorship](https://img.shields.io/badge/support-me-red.svg)](https://github.com/users/rix1337/sponsorship)
        [![Gitter](https://img.shields.io/gitter/room/FeedCrawler/community)](https://gitter.im/FeedCrawler/community)
        [![GitHub issues](https://img.shields.io/github/issues/rix1337/FeedCrawler.svg)](https://github.com/rix1337/FeedCrawler/issues)
        
        ***
        
        ## Installation
        
        ### Voraussetzungen
        
        * [Python 3.7](https://www.python.org/downloads/) oder neuer
        * [JDownloader 2](http://www.jdownloader.org/jdownloader2) mit [My JDownloader-Konto](https://my.jdownloader.org)
        * [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) ab v.2.0.0 um Cloudflare-Blockaden zu umgehen (optional)
        
        ### Lokaler Build
        Benötigt [Node.js](https://nodejs.org/en/download/), [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) und [pip](https://pip.pypa.io/en/stable/installation/):
        
        1. Frontend-Pfad aufrufen: `cd feedcrawler/web`
        2. Dependencies installieren: `npm ci`
        3. [Vue.js 3](https://vuejs.org/) Frontend kompilieren: `npm run build`
        4. Zurück in das Hauptverzeichnis wechseln: `cd ../..`
        5. FeedCrawler auf Basis der _setup.py_ installieren: `pip install .`
        
        ### [pip](https://pip.pypa.io/en/stable/installation/)
        
        #### Installieren
        
        ```pip install feedcrawler```
        
        Hinweise zur manuellen Installation und Einrichtung finden sich im [Wiki](https://github.com/rix1337/FeedCrawler/wiki)!
        
        #### Update
        
        ```pip install -U feedcrawler```
        
        #### Starten
        
        ```feedcrawler``` in der Konsole (Python muss im System-PATH hinterlegt sein)
        
        ### [Docker Image](https://hub.docker.com/r/rix1337/docker-feedcrawler/)
        
        * Der Betrieb als Docker-Container empfiehlt sich als Standardinstallation - vor allem für NAS-Systeme, Homeserver und
          sonstige Geräte die dauerhaft und möglichst wartungsfrei (headless) betrieben werden sollen.
        * Bei jedem Release wird ein getaggtes Image erstellt. Damit kann man auf der Wunschversion verbleiben oder im Falle
          eines Bugs zu einer stabilen Version zurück kehren.
        * Um immer auf dem aktuellen Stand zu sein, einfach das mit `latest` getaggte Image nutzen.
        * Für UNRAID-Server kann das Image direkt über die Community Applications bezogen und der Container so eingerichtet
          werden.
        
        ### Windows Exe
        
        * Jedem [Release](https://github.com/rix1337/FeedCrawler/releases) wird eine selbstständig unter Windows lauffähige
          Version des FeedCrawlers beigefügt.
        * Hierfür müssen weder Python, noch die Zusatzpakete installiert werden.
        * Einfach die jeweilige Exe herunterladen und ausführen bzw. bei Updates die Exe ersetzen.
        
        ### Hostnamen festlegen
        
        FeedCrawler kann zum durchsuchen beliebiger Webseiten verwendet werden. Ausschließlich der Anwender entscheidet, welche
        Seiten durchsucht werden sollen. Diese Entscheidung trifft der Anwender selbstständig, indem er die _FeedCrawler.ini_ in
        der Kategorie _[Hostnames]_ manuell befüllt (_ab = xyz.com_). Eingetragen werden dort reine Hostnamen (ohne _https://_).
        
        #### Dabei gilt
        
        * Welcher Hostname aufgerufen wird entscheidet allein der Anwender.
        * Ist nicht mindestens ein Hostname gesetzt, wird der FeedCrawler nicht starten.
        * Passt die aufgerufene Seite hinter dem jeweiligen Hostnamen nicht zum Suchmuster des FeedCrawlers, kann es zu Fehlern
          kommen.
        * Weder FeedCrawler noch der Autor benennen oder befürworten spezifische Hostnamen. Fragen hierzu werden ignoriert!
        
        ### Startparameter
        
        | Parameter                      | Erläuterung |
        |--------------------------------|---|
        | ```--log-level=<LOGLEVEL>```   | Legt fest, wie genau geloggt wird (`CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`, `NOTSET`) |
        | ```--config="<PFAD>"```        | Legt den Ablageort für Einstellungen und Logs fest |
        | ```--port=<PORT>```            | Legt den Port des Webservers fest |
        | ```--jd-user=<NUTZERNAME>```   | Legt den Nutzernamen für My JDownloader fest |
        | ```--jd-pass=<PASSWORT>```     | Legt das Passwort für My JDownloader fest |
        | ```--jd-device=<GERÄTENAME>``` | Legt den Gerätenamen für My JDownloader fest (optional, wenn nur ein Gerät vorhanden ist) |
        
        ### Sicherheitshinweis
        
        Der Webserver sollte nie ohne Absicherung im Internet freigegeben werden. Dazu lassen sich im Webinterface Nutzername
        und Passwort festlegen.
        
        Es empfiehlt sich, zusätzlich einen Reverse-Proxy mit HTTPs-Zertifikat,
        bspw. [kostenlos von letsencrypt](https://letsencrypt.org/), zu verwenden.
        
        ## Credits
        
        * [zapp-brannigan](https://github.com/zapp-brannigan/) (Idee)
        * Gutz-Pilz (Idee)
        * [mmarquezs](https://github.com/mmarquezs/) (MyJDownloader-API für Python)
        * [JetBrains PyCharm](https://www.jetbrains.com/?from=FeedCrawler) (Lizenz für die IDE)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
