readme: updated readme

README.md

@@ -1,65 +1,97 b''
 AppEnlight
 -----------
 
 Automatic Installation
 ======================
 
 Use the ansible scripts in the `/automation` directory to build complete instance of application
 You can also use `packer` files in `/automation/packer` to create whole VM's for KVM and VMWare.
 
 Manual Installation
 ===================
 
+To run the app you need to have meet prerequsites:
+
+- python 3.5+
+- running elasticsearch (2.3+ tested)
+- running postgresql (9.5+ required)
+- running redis
+
 Install the app by performing
 
     pip install -r requirements.txt
     
     python setup.py develop
 
-To run the app and configure datastore you need to run:
-
-* python 3.5+
-* elasticsearch (2.2+ tested)
-* postgresql 9.5+
-* redis 2.8+
+Install the appenlight uptime plugin (`ae_uptime_ce` package).
 
-after installing the application you need to:
+After installing the application you need to perform following steps:
 
 1. (optional) generate production.ini (or use a copy of development.ini)
 
+
     appenlight-make-config production.ini
 
-2. setup database structure:
+2. Setup database structure:
+
 
     appenlight-migrate-db -c FILENAME.ini
 
-3. to configure elasticsearch:
+3. To configure elasticsearch:
 
-    appenlight-reindex-elasticsearch -c FILENAME.ini
 
-4. create base database objects
+    appenlight-reindex-elasticsearch -t all -c FILENAME.ini
+
+4. Create base database objects
+
 
     appenlight-initializedb -c FILENAME.ini
 
-5. generate static assets
+5. Generate static assets
+
 
     appenlight-static -c FILENAME.ini
 
 Running application
 ===================
 
-to run the main app:
+To run the main app:
 
     pserve development.ini
 
-to run celery workers:
+To run celery workers:
 
     celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
 
-to run celery beat:
+To run celery beat:
 
     celery beat -A appenlight.celery --ini FILENAME.ini
 
-to run appenlight's uptime plugin:
+To run appenlight's uptime plugin:
 
     appenlight-uptime-monitor -c FILENAME.ini
+
+Real-time Notifications
+=======================
+
+You should also run the `channelstream websocket server for real-time notifications
+
+    channelstream -i filename.ini
+    
+Testing
+=======
+
+To run test suite:
+
+    py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
+
+
+Development
+===========
+
+To develop appenlight frontend:
+
+    cd frontend
+    npm install
+    bower install
+    grunt watch

backend/setup.py

@@ -1,77 +1,77 b''
 import os
 import sys
 import re
 
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.md')).read()
+README = open(os.path.join(here, '..', 'README.md')).read()
 CHANGES = open(os.path.join(here, 'CHANGELOG.rst')).read()
 
 REQUIREMENTS = open(os.path.join(here, 'requirements.txt')).readlines()
 
 compiled = re.compile('([^=><]*).*')
 
 
 def parse_req(req):
     return compiled.search(req).group(1).strip()
 
 
 requires = [_f for _f in map(parse_req, REQUIREMENTS) if _f]
 
 
 def _get_meta_var(name, data, callback_handler=None):
     import re
     matches = re.compile(r'(?:%s)\s*=\s*(.*)' % name).search(data)
     if matches:
         if not callable(callback_handler):
             callback_handler = lambda v: v
 
         return callback_handler(eval(matches.groups()[0]))
 
 with open(os.path.join(here, 'src', 'appenlight', '__init__.py'), 'r') as _meta:
     _metadata = _meta.read()
 
 with open(os.path.join('src', 'appenlight', 'VERSION')) as _meta_version:
     __version__ = _meta_version.read().strip()
 
 __license__ = _get_meta_var('__license__', _metadata)
 __author__ = _get_meta_var('__author__', _metadata)
 __url__ = _get_meta_var('__url__', _metadata)
 
 found_packages = find_packages('src')
 found_packages.append('appenlight.migrations.versions')
 setup(name='appenlight',
       description='appenlight',
       long_description=README + '\n\n' + CHANGES,
       classifiers=[
           "Programming Language :: Python",
           "Framework :: Pylons",
           "Topic :: Internet :: WWW/HTTP",
           "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
       ],
       version=__version__,
       license=__license__,
       author=__author__,
       url=__url__,
       keywords='web wsgi bfg pylons pyramid',
       package_dir={'': 'src'},
       packages=found_packages,
       include_package_data=True,
       zip_safe=False,
       test_suite='appenlight',
       install_requires=requires,
       entry_points={
           'paste.app_factory': [
               'main = appenlight:main'
           ],
           'console_scripts': [
               'appenlight-cleanup = appenlight.scripts.cleanup:main',
               'appenlight-initializedb = appenlight.scripts.initialize_db:main',
               'appenlight-migratedb = appenlight.scripts.migratedb:main',
               'appenlight-reindex-elasticsearch = appenlight.scripts.reindex_elasticsearch:main',
               'appenlight-static = appenlight.scripts.static:main',
               'appenlight-make-config = appenlight.scripts.make_config:main',
           ]
       }
       )