ability to run with custom checker/collectors

Author: DevAlone

README.rst

@@ -226,39 +226,94 @@ anything, just run
 
 inside virtual environment in proxy_py project directory.
 
+How to use custom checkers/collectors?
+**************************************
+
+If you wan't to collect proxies from your source or you need proxies to work with particular site,
+you can write your own collectors or/and checkers.
+
+1. Create your checkers/collectors in current directory following the next directory structure:
+
+// TOOD: add more detailed readme about it
+
+```
+
+local/
+├── requirements.txt
+├── checkers
+│   └── custom_checker.py
+└── collectors
+    └── custom_collector.py
+
+```
+
+You can create only checker or collector if you want so
+
+2. Create `proxy_py/settings.py` in current dir with the following content
+
+```python3
+
+from ._settings import *
+from local.checkers.custom_checker import CustomChecker
+
+PROXY_CHECKERS = [CustomChecker]
+
+COLLECTORS_DIRS = ['local/collectors']
+
+```
+
+you can append your checker to PROXY_CHECKERS or COLLECTORS_DIRS instead of overriding to use built in ones as well, it's just normal python file. 
+See `proxy_py/_settings.py` for more detailed instructions on options.
+
+3. Follow the steps in "How to install?" but download this docker-compose config instead    
+
+```bash
+wget "https://raw.githubusercontent.com/DevAlone/proxy_py/master/docker-compose-with-local.yml"
+```
+
+and run with command
+
+```bash
+docker-compose -f docker-compose-with-local.yml up
+```
+
+4. ...?
+
+5. Profit!
+
 How to build from scratch?
 **************************
 
-1 Clone this repository
+1. Clone this repository
 
 .. code-block:: bash
 
    git clone https://github.com/DevAlone/proxy_py.git
 
-2 Install requirements
+2. Install requirements
 
 .. code-block:: bash
 
    cd proxy_py
    pip3 install -r requirements.txt
 
-3 Create settings file
+3. Create settings file
 
 .. code-block:: bash
 
    cp config_examples/settings.py proxy_py/settings.py
 
-4 Install postgresql and change database configuration in settings.py file
+4. Install postgresql and change database configuration in settings.py file
 
-5 (Optional) Configure alembic
+5. (Optional) Configure alembic
 
-6 Run your application
+6. Run your application
 
 .. code-block:: bash
 
    python3 main.py
 
-7 Enjoy!
+7. Enjoy!
 
 
 Mirrors

docker-compose-with-local.yml

@@ -0,0 +1,35 @@
+version: '3'
+
+services:
+    db:
+        image: "postgres:12"
+        restart: always
+        environment:
+            - POSTGRES_USER=proxy_py
+            - POSTGRES_PASSWORD=proxy_py
+            - POSTGRES_DB=proxy_py
+        volumes:
+            - db_data:/var/lib/postgresql/data
+            - ./init_db.sql:/docker-entrypoint-initdb.d/init_db.sql
+    core:
+        image: "devalone/proxy_py:latest"
+        command: >
+          bash -c "
+            source /proxy_py/env/bin/activate &&
+            pip3 install -r /proxy_py/local/requirements.txt &&
+            /proxy_py/run.sh
+          "
+        restart: always
+        ports:
+            - "55555:55555"
+        environment:
+            - PROXY_PY_PROXY_PROVIDER_SERVER_ADDRESS={'HOST':'0.0.0.0','PORT':55555}
+            - PROXY_PY_DATABASE_CONNECTION_KWARGS={'host':'db','database':'proxy_py','user':'proxy_py','password':'proxy_py'}
+        depends_on:
+            - db
+        volumes:
+            - ./local/:/proxy_py/local/
+            - ./proxy_py/settings.py:/proxy_py/proxy_py/settings.py
+
+volumes: 
+    db_data: