skip to navigation
skip to content

Not Logged In

CodeShow 0.1.0

CodeShow turns a directory of code into a static website suitable for use in presentations.

Latest Version: 0.2.2

# CodeShow

CodeShow turns a directory of code into a static website suitable for use in presentations. It uses [pygments](http://pygments.org) for syntax highlighting. In directories that include a readme.md or readme.txt, the readme contents will be displayed under the directory listing.

Passing --site44 generates content optimized for hosting on Site44:

  1. No .html or .txt file extensions are appended to files. This makes for prettier URLs.
  2. A mimetypes.site44.txt file is generated that enforces HTML and plain text content types for those pretty URLs.

See [codeshow.site44.com](http://codeshare.site44.com) for an example of the output, or get the code at [github.com/smarx/codeshow](https://github.com/smarx/codeshow).

## Installation

Use pip install codeshow to install.

## Usage

usage: codeshow [path] [<options>]

CodeShow turns a directory of code into a static website suitable for use in presentations.

positional arguments:
PATH path to the code project
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-o, --output PATH
 output path for generated website
-i, --ignore PATH
 relative path to skip (can be specified multiple times)
-f, --force if the output directory already exists, delete it first
-s, --site44 generate output for Site44 (generate mimetypes.site44.txt instead of using file extensions)
 
File Type Py Version Uploaded on Size
CodeShow-0.1.0.tar.gz (md5) Source 2012-09-09 6KB
  • Downloads (All Versions):
  • 12 downloads in the last day
  • 82 downloads in the last week
  • 400 downloads in the last month
  • Author: Steve Marx
  • Home Page: http://codeshow.site44.com
  • License:
    Copyright (C) 2012 Steve Marx
    
    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Package Index Owner: smarx
  • DOAP record: CodeShow-0.1.0.xml