Add README and dotenv

Dockerfile

@@ -3,6 +3,6 @@ FROM debian
 RUN apt-get update ; apt-get -y upgrade && \
     apt-get -y install python3 python3-pip \
                        python3-flask python3-flask-sqlalchemy python3-flask-httpauth python3-flaskext.wtf \
-                       python3-pymysql python3-requests python3-bs4 && \
+                       python3-pymysql python3-requests python3-bs4 python3-dotenv && \
     apt-get -y --no-install-recommends install phantomjs && \
     rm -rf /var/lib/apt/lists/*

README.md

@@ -0,0 +1,68 @@
+# 𝛑 😼 た
+> Xéfir's personal animes torrent search engine
+
+I'm lazy and I want to search across severall VF and VOSTFR torrents databases in one click.
+That's the starting point that build this app.
+At first, it was a crappy PHP project without any good futur.
+After a good rewrite in Python, it's time to show it to the public, and here it is!
+
+## Installing / Getting started
+
+### With Docker
+
+- Install Docker: https://hub.docker.com/search/?type=edition&offering=community
+- Clone this repository
+- Launch a terminal and move into the root of the cloned repository
+- Run￿ `docker-compose up -d`
+- The app is accessible at http://localhost:5000
+
+### Without Docker
+
+- Install Python 3: https://www.python.org/downloads/
+- Install Pip: https://pip.pypa.io/en/stable/installing/
+- Install MariaDB (or any MySQL server): https://mariadb.com/downloads/
+- Clone this repository
+- Launch a terminal and move into the root of the cloned repository
+- Run `pip install -r requirements.txt`
+- Copy the `.env.dist` file to `.env` and ajust values to point to your MySQL server
+- Run `python3 app.py`
+- The app is accessible at http://localhost:5000
+
+## Features
+
+* Search on Nyaa.si, Nyaa.net, YggTorrent and Anime-Ultime
+* Provide useful links to TheTVDB, Nautiljon and AnimeMangaDDL during a search
+* Color official and bad links
+* Add seeded links to a database
+* Color seeded link on search
+* Run a batch to list all dead link on database
+
+## Configuration
+
+All is managed by environment variables.
+Please look into the `.env.dist` file to list all env variables possible.
+
+## Links
+
+- Project homepage: https://nyaa.crystalyx.net/
+- Repository: https://git.crystalyx.net/Xefir/PyNyaaTa
+- Issue tracker: https://git.crystalyx.net/Xefir/PyNyaaTa/issues
+- My other projects: https://git.crystalyx.net/Xefir
+
+## Licensing
+
+```
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
+```

config.py

@@ -3,10 +3,12 @@ from sys import modules
 
 import pymysql
 from flask import Flask
+from flask.cli import load_dotenv
 from flask_httpauth import HTTPBasicAuth
 from flask_sqlalchemy import SQLAlchemy
 
 modules["MySQLdb"] = pymysql
+load_dotenv()
 
 # init DB and migration
 db_user = environ.get('MYSQL_USER')

requirements.txt

@@ -5,3 +5,4 @@ Flask-WTF===0.14.2
 PyMySQL==0.9.3
 requests==2.21.0
 beautifulsoup4==4.7.1
+python-dotenv==0.9.1