readme: reorganization

backend/CHANGELOG.md

@@ -0,0 +1,21 b''
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+<!--
+   PRs should document their user-visible changes (if any) in the
+   Unreleased section, uncommenting the header as necessary.
+-->
+
+<!-- ## Unreleased -->
+<!-- ### Changed -->
+<!-- ### Added -->
+<!-- ### Removed -->
+<!-- ### Fixed -->
+
+
+## [1.2.0 - 2019-03-17]
+### Changed
+* Replaced elasticsearch client
+* Bumped a most deps to latest version
+* Preparing to move from elasticsearch 2.x to modern versions

backend/README.md

@@ -0,0 +1,105 b''
+AppEnlight
+-----------
+
+Automatic Installation
+======================
+
+Use the ansible scripts in the `automation` repository 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+/2.4 tested)
+- running postgresql (9.5+ required)
+- running redis
+
+Install the app by performing
+
+    pip install -r requirements.txt
+    
+    python setup.py develop
+
+Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
+
+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:
+
+
+    appenlight-migratedb -c FILENAME.ini
+
+3. To configure elasticsearch:
+
+
+    appenlight-reindex-elasticsearch -t all -c FILENAME.ini
+
+4. Create base database objects 
+
+   (run this command with help flag to see how to create administrator user)
+
+
+    appenlight-initializedb -c FILENAME.ini
+
+5. Generate static assets
+
+
+    appenlight-static -c FILENAME.ini
+
+Running application
+===================
+
+To run the main app:
+
+    pserve development.ini
+
+To run celery workers:
+
+    celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
+
+To run celery beat:
+
+    celery beat -A appenlight.celery --ini FILENAME.ini
+
+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
+
+
+Tagging release
+===============
+
+    bumpversion --current-version 1.1.1 minor --verbose --tag --commit --dry-run

README.md

@@ -1,105 +1,4 b''
-AppEnlight
------------
+Visit:
 
-Automatic Installation
-======================
 
-Use the ansible scripts in the `automation` repository 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+/2.4 tested)
-- running postgresql (9.5+ required)
-- running redis
-
-Install the app by performing
-
-    pip install -r requirements.txt
-    
-    python setup.py develop
-
-Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
-
-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:
-
-
-    appenlight-migratedb -c FILENAME.ini
-
-3. To configure elasticsearch:
-
-
-    appenlight-reindex-elasticsearch -t all -c FILENAME.ini
-
-4. Create base database objects 
-
-   (run this command with help flag to see how to create administrator user)
-
-
-    appenlight-initializedb -c FILENAME.ini
-
-5. Generate static assets
-
-
-    appenlight-static -c FILENAME.ini
-
-Running application
-===================
-
-To run the main app:
-
-    pserve development.ini
-
-To run celery workers:
-
-    celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
-
-To run celery beat:
-
-    celery beat -A appenlight.celery --ini FILENAME.ini
-
-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
-
-
-Tagging release
-===============
-
-    bumpversion --current-version 1.1.1 minor --verbose --tag --commit --dry-run
+[Readme moved to backend directory](../appenlight/blob/master/backend/README.md)

backend/setup.py

@@ -1,89 +1,89 b''
 import os
 import re
 
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, "README.rst")).read()
-CHANGES = open(os.path.join(here, "CHANGELOG.rst")).read()
+README = open(os.path.join(here, "README.md")).read()
+CHANGES = open(os.path.join(here, "CHANGELOG.md")).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(here, "VERSION"), "r") 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,
     extras_require={
         "dev": [
             "coverage",
             "pytest",
             "pyramid",
             "tox",
             "mock",
             "pytest-mock",
             "webtest",
         ],
         "lint": ["black"],
     },
     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",
         ],
     },
 )