Revert "[build] #16 add documentation"

This reverts commit 7265cf2

Author: stanislav-web

README.md

@@ -1,6 +1,4 @@
-### PyRuc (Python Redis Users Controller)
-PyRuc is the service for maintaining new and existing users accounts
-
+### PyRuc is the service for maintaining user accounts (UAC)
 [![Coverage Status](https://coveralls.io/repos/github/stanislav-web/PyRuc/badge.svg?branch=master)](https://coveralls.io/github/stanislav-web/PyRuc?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/810e623b6db74357ba10915f4247aa6d)](https://www.codacy.com/app/stanisov/PyRuc?utm_source=github.com&utm_medium=referral&utm_content=stanislav-web/PyRuc&utm_campaign=Badge_Grade) [![GitHub license](https://img.shields.io/github/license/stanislav-web/PyRuc.svg)](https://github.com/stanislav-web/PyRuc/blob/master/LICENSE)
 
 |  Python | Status |
@@ -22,44 +20,36 @@ PyRuc is the service for maintaining new and existing users accounts
 - Gevent as default async worker for Gunicorn
 - Python flask
 - Twilio SMS notifier
-- Logstash client as logs filter to Elastic
+- ELK client for as log transport
 - JWT authentication
 - Redis as persistent user's storage
 
-##### Configuration
-```bash
-/app/env/development.env
-/app/env/production.env
-```
-You also could setup your build out of the docker container.
-Please install `dotenv` pip package for realize your custom environments
-
 ##### Installation
 - Docker
 ```bash
 
 # ENV development: using /app/env/development.env
-> docker-compose --file docker-compose.dev.yml up --build
+docker-compose --file docker-compose.dev.yml up --build
 
 # ENV production: using /app/env/production.env
-> docker-compose --file docker-compose.prod.yml up --build
+docker-compose --file docker-compose.prod.yml up --build
+
 ```
 - Manualy & Run
 ```bash
-> cd app 
-> pip install -r requirements.txt
-> gunicorn -c config.py server --reload
+pip install -r requirements.txt
+gunicorn -c config.py server --reload
 ```
-
 ##### Try API
 [http://drunk-start.surge.sh](http://drunk-start.surge.sh)
 
+
 ##### Diagrams
 ![Registration](images/registration.png)
 ![Authentication](images/authentication.png)
 ![Restore](images/restore.png)
 
 #### Tests
 ```bash
-> cd app && coverage run setup.py test
-```
+cd app && coverage run setup.py test
+```

app/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis User Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.

app/env/production.env

@@ -20,8 +20,8 @@ SERVER_PORT=5001
 
 REDIS_HOST=redis
 REDIS_PORT=6379
-REDIS_DBNO=1
 REDIS_PASSWORD=d70e25e734dedbd1ca52fe81459b23af88f82819d06a823e07a79a86955e8ac8
+REDIS_DBNO=1
 REDIS_SOCKET_TIMEOUT=10
 REDIS_SOCKET_CONNECT_TIMEOUT=3
 REDIS_MAX_CONNECTIONS=3

app/server.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.

app/setup.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.

app/src/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.

app/src/app.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.
@@ -23,11 +23,7 @@
 logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
 logger = logging.getLogger(config.APPLICATION)
 logger.setLevel(config.APPLICATION_LOG_LEVEL)
-logger.addHandler(logstash.TCPLogstashHandler(config.LOGSTASH_HOST,
-                                              config.LOGSTASH_PORT,
-                                              message_type=config.LOGSTASH_NODENAME,
-                                              fqdn=True,
-                                              version=1))
+logger.addHandler(logstash.TCPLogstashHandler(config.LOGSTASH_HOST, config.LOGSTASH_PORT, version=1))
 
 try:
     application = Flask(config.APPLICATION)

app/src/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.
@@ -18,5 +18,4 @@
 APPLICATION_LIMIT_PER_MIN = os.getenv('APPLICATION_LIMIT_PER_MIN', '100000 per minute')
 APPLICATION_LIMIT_STORAGE_URI = os.getenv('APPLICATION_LIMIT_STORAGE_URI', 'redis://127.0.0.1:6379')
 LOGSTASH_HOST = os.getenv('LOGSTASH_HOST', '127.0.0.1')
-LOGSTASH_PORT = int(os.getenv('LOGSTASH_PORT', 6000))
-LOGSTASH_NODENAME = os.getenv('LOGSTASH_NODENAME', 'pyruc')
+LOGSTASH_PORT = os.getenv('LOGSTASH_PORT', 6000)

app/src/modules/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.

app/src/modules/mod_authentication/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-""" PyRuc-Python Redis Users Controller
+""" PyRuc-UAC-SERVICE
     Copyright (C) 2007 Free Software Foundation, Inc.
     Everyone is permitted to copy and distribute verbatim copies of this license document,
     but changing it is not allowed.