Skip to main content

A package and CLI for writing dissertations.

Project description

https://travis-ci.org/jbn/dissertate.svg?branch=master https://ci.appveyor.com/api/projects/status/69kj3prrrieyp8q2/branch/master?svg=true https://coveralls.io/repos/github/jbn/dissertate/badge.svg?branch=master https://img.shields.io/pypi/v/dissertate.svg https://img.shields.io/badge/license-MIT-blue.svg https://img.shields.io/pypi/pyversions/dissertate.svg

Installation

pip install dissertate

Basic Usage

In nb_config.py,

import dissertate

c = get_config()

c.Exporter.preprocessors = ['dissertate.preprocessors.EmptyCellElider',
                            'dissertate.preprocessors.CellElider']

c.Exporter.template_file = dissertate.markdown_template_path()

then,

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,

{"tags": ["private"]}

Alternatively, you can use

{"tags": ["todo"]}

or,

{"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),

{"tags": ["output-generator"]}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dissertate-0.0.9.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file dissertate-0.0.9.tar.gz.

File metadata

  • Download URL: dissertate-0.0.9.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for dissertate-0.0.9.tar.gz
Algorithm Hash digest
SHA256 937276b573ff603fbefc689a34c1550d6638dea1f0ef064f7ab718d5d4b29b0d
MD5 da55bf0aa310e30af8991217f74205c0
BLAKE2b-256 84cacc7d344ca205074f6a348d518065a1f795bf4b9c8e7c6e7373a25729e13f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page