Metadata-Version: 1.2
Name: dissertate
Version: 0.0.7
Summary: A package and CLI for writing dissertations.
Home-page: https://github.com/jbn/dissertate
Author: John Bjorn Nelson (generativist)
Author-email: jbn@abreka.com
Maintainer: John Bjorn Nelson (generativist)
Maintainer-email: jbn@abreka.com
License: MIT
Description: .. image:: https://travis-ci.org/jbn/dissertate.svg?branch=master
            :target: https://travis-ci.org/jbn/dissertate
        .. image:: https://ci.appveyor.com/api/projects/status/69kj3prrrieyp8q2/branch/master?svg=true
            :target: https://ci.appveyor.com/project/jbn/dissertate/branch/master 
        .. image:: https://coveralls.io/repos/github/jbn/dissertate/badge.svg?branch=master
            :target: https://coveralls.io/github/jbn/dissertate?branch=master 
        .. image:: https://img.shields.io/pypi/v/dissertate.svg
            :target: https://pypi.python.org/pypi/dissertate
        .. image:: https://img.shields.io/badge/license-MIT-blue.svg
            :target: https://raw.githubusercontent.com/jbn/dissertate/master/LICENSE
        .. image:: https://img.shields.io/pypi/pyversions/dissertate.svg
            :target: https://pypi.python.org/pypi/dissertate
        
        Installation
        ------------
        
        .. code:: sh
        
           pip install dissertate
        
        
        Basic Usage
        -----------
        
        In ``nb_config.py``,
        
        .. code:: python
        
           import dissertate
        
           c = get_config()
        
           c.Exporter.preprocessors = ['dissertate.preprocessors.EmptyCellElider',
                                       'dissertate.preprocessors.CellElider']
        
           c.Exporter.template_file = dissertate.markdown_template_path()
        
        then,
        
        .. code:: sh
        
           jupyter nbconvert --config nb_config.py --to markdown your_nb.ipynb
        
        If you don't want a cell in the output, edit the cell metadata to include,
        
        .. code:: json
        
           {"tags": ["private"]}
        
        Alternatively, you can use
        
        .. code:: json
        
           {"tags": ["todo"]}
        
        or,
        
        .. code:: json
        
           {"tags": ["setup"]}
        
        for semantic differences that have no effect on ``dissertate`` processing.
        
        If you want to retain the output of the cell but not the code (e.g.,
        for an emitted ``matplotlib`` graph),
        
        .. code:: json
        
           {"tags": ["output-generator"]}
        
        
Keywords: phd,dissertation,thesis,jupyter,ipython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: IPython
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
