Metadata-Version: 2.1
Name: jupyteranalytics
Version: 1.0
Summary: Adds Google Analytics to Jupyter notebooks
Home-page: UNKNOWN
Author: PingThings, Inc.
Author-email: support@pingthings.io
Maintainer: PingThings, Inc.
Maintainer-email: support@pingthings.io
License: BSD-3-Clause
Download-URL: https://github.com/PingThingsIO/jupyter-analytics/tarball/v1.0
Project-URL: Download, https://github.com/PingThingsIO/jupyter-analytics/tarball/v1.0
Project-URL: Source, https://github.com/PingThingsIO/jupyter-analytics
Project-URL: Tracker, https://github.com/PingThingsIO/jupyter-analytics/issues
Description: # Jupyter Analytics
        
        A simple Jupyter Notebook extension to inject [Google Analytics](https://www.google.com/analytics/) tracking code into notebooks and JupyterHub web pages. This extension is based on [yuvipanda/nbgoogleanyltics](https://github.com/yuvipanda/nbgoogleanalytics) but is extended for larger JupyterHub deployments.
        
        ## Installation
        
        Install the extension as follows:
        
        ```
        $ pip install jupyteranalytics
        ```
        
        This should both install and enable the `jupyteranalytics` extension. Verify with:
        
        ```
        $ jupyter nbextension list
        $ jupyter serverextension list
        ```
        
        There are a couple of reasons why this might not have been installed and enabled automagically. If not, you can manually install and enable as follows:
        
        ```
        $ jupyter nbextension install --py --sys-prefix jupyteranalytics
        $ jupyter nbextension enable --py --sys-prefix jupyteranalytics
        $ jupyter serverextension enable --py --sys-prefix jupyteranalytics
        ```
        
        Note that both the automatic and manual methods install `jupyteranalytics` to your virtualenv using the `--sys-prefix` flag by default. Alternatively you can omit this flag or specify `--user` to install the configuration to your user configuration or you can use `--system` to install the extension systemwide.
        
        **Warning**: For Google Analytics tracking to appear on every page (including the directory listing), the configuration must be in `nbconfig/common.json`, the pip installer will copy a new configuration to the virtualenv location; ensure that you make a backup of any existing `nbconfig.common.json` file. Note that this will not affect user or system installs, which require manual enabling of the extension.
        
        ## Configuration
        
        The configuration property required by this extension is a Google Analytics Tracking ID, which can be obtained after you set up a Google Analytics property. This ID looks something like `UA-#########-#`.
        
        To quickly get started you can pass this id as a command line parameter:
        
        ```
        $ jupyter notebook --GoogleAnalytics.tracking_id="UA-#########-#"
        ```
        
        To permenantly enable tracking on all notebook pages, check the path to your configuration using `jupyter nbextension list`. Then, in `<config_path>/common.json` add the following:
        
        ```json
        {
            "GoogleAnalytics": {
                "tracking_id": "UA-#########-#"
            }
        }
        ```
        
        You should note that the notebook logger will indicate if tracking is enabled or not if it can find the Tracking ID.
        
Keywords: Google Analytics,notebooks,Jupyter,JupyterHub
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.4, <4
Description-Content-Type: text/markdown
