Metadata-Version: 1.0
Name: qa-reporting
Version: 0.1+git60
Summary: Web app for creating QA reports
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Description: qa-reporting
        ============
        
        Web app for creating QA reports.
        
        Requirements
        ------------
        
        You will need the following things properly installed on your machine:
        
        * Python 3.5+
        * MongoDB 3+
        * Node.js 5+ (with NPM)
        
        Installation
        ------------
        
        Development Environment
        ~~~~~~~~~~~~~~~~~~~~~~~
        
        1. Install system requirements:
        
        .. code-block:: shell
        
            $ sudo apt-get install build-essential python3.5-dev python3-pip mongodb nodejs
            $ sudo pip3 install virtualenv
        
        2. Install Python requirements:
        
        .. code-block:: shell
        
            $ cd qa-reporting
            $ virtualenv .venv
            $ source .venv/bin/activate
            $ pip install -r requirements.txt
        
        3. Install JavaScript requirements and run webpack-devserver:
        
        .. code-block:: shell
        
            $ npm install
            $ npm run start
        
        4. Make sure that MongoDB is running:
        
        .. code-block:: shell
        
            $ sudo service mongodb start
        
        5. Create local configuration file in `/etc/qareporting/qareporting.conf`
           or `~/qareporting.conf` and populate it with Google and TestRail
           credentials. If you want to create your own credentials for Google oauth,
           go to https://console.developers.google.com "APIs & Auth" -> Credentials
           and create new credentials there.
        
        6. Load fixtures:
        
        .. code-block:: shell
        
           $ python manage.py populate_db
        
        7. Sync the database with TestRail:
        
        .. code-block:: shell
        
           $ python manage.py sync_testrail --all
        
        8. Start your local development server:
        
        .. code-block:: shell
        
           $ python manage.py runserver
        
        Production Environment
        ~~~~~~~~~~~~~~~~~~~~~~
        
        TODO
        
        Hacking
        -------
        
        To run tests and linters:
        
        .. code-block:: shell
        
            $ pip install tox
            $ tox
            $ npm run lint
        
        
Platform: UNKNOWN
