Metadata-Version: 2.1
Name: frtg
Version: 0.5.2
Summary: Flask/React Twitter grid
Home-page: https://github.com/susrik/frtg
Author: Erik Reid
Author-email: nobody@nowhere.org
License: UNKNOWN
Description: # FRTG - Flask/React Twitter Grid
        
        * [Overview](#overview)
        * [Package-based Installation](#package-based-installation)
          * [From PyPI](#from-pypi)
          * [From Source](#from-source)
        * [Running](#running)
          * [Configuration](#configuration)
          * [Starting the Server](#starting-the-server)
        * [Development Environment](#development-environment)
          * [Setup](#setup)
          * [Generate Javascript Bundle](#generate-javascript-bundle)
        
        ## Overview
        
        This is a basic project for serving a npm-managed React
        app with Flask.  It renders twitter query results
        in a grid in a way convenient for diplaying on
         a kiosk or large screen.
         
        ## Package-based installation
        
        Create a (python 3) virtualenv and
        install using one of the following methods:
        
        ### From PyPi
        
        ```bash
        $ pip install frtg
        ```
        
        ### From Source
        
        ```bash
        $ python setup.py sdist
        $ pip install dist/frtg-x.y.z.tar.gz
        ```
        
        # Running
        
        ## Configuration
        
        Use `config-example.json` as a template to
        create a configuration file.
        When running the server an environment variable called
        `CONFIG_FILENAME` and containing the path to this
        configuration file must be present.
        
        ## Starting the Server
        
        ```bash
        CONFIG_FILENAME=config.json FLASK_APP=frtg flask run
        ```
        
        Note: if you are running from a source distribution
        and didn't install it in your virtualenv, you should
        execute the above from the top-level folder.
        
        Alternatively, using the provided `app.py`
        might sometimes be convenient when developing:
        
        ```bash
        CONFIG_FILENAME=config.json python frtg/app.py
        ```
        
        or:
        
        ```bash
        CONFIG_FILENAME=config.json python -m frtg.app
        ```
        
        
        ## Development Environment
        
        These notes are for setting up a development environment.
        
        ### Setup
        
        Create a (python 3) virtualenv and install the requirements:
        
        ```bash
        $ pip install -e .
        ```
        
        ... and, to install additional libraries used by the test scripts:
        
        ```bash
        $ pip install -r requirements.txt
        ```
        
        Set up the node environment:
        
        ```bash
        npm install
        ```
        
        ### Generate Javascript Bundle
        
        In a fresh environment, or whenever the ui
        sources are changed:
        
        ```bash
        npm run build
        ```
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.5
Description-Content-Type: text/markdown
