skip to navigation
skip to content

Not Logged In

orgviz 0.0.1.dev0

view org-mode files from different directions

Build Status

Warning

Work in progress.

In OrgViz, you can...

  • View org-mode files in different formats: calendar / table / histogram
  • Use rich formatting of web browsers but everything is reachable from keyboard.
  • Write complex filter settings in Python.

Install

Installing OrgViz is as easy as:

pip install orgviz  # or
easy_install orgviz

If you want to draw graphs, install matplotlib.

Usage

Use the following command to start OrgViz server and the open http://127.0.0.1:8000 in your browser:

orgviz serve --port 8000 --conf YOUR/CONF/PATH.py

If you want to reload server automatically when you rewrite the configuration file, currently you need to add --debug option:

orgviz serve --debug [OTHER OPTIONS]

To quickly checkout what OrgViz can do, simply do:

orgviz sample

This will make a configuration file and a randomly generated org file in ./sample/ directory and start OrgViz server with them. You can edit the generated org file and see what happens to the pages in OrgViz.

Configuration

Here is a minimal configuration.:

ORG_COMMON_FILES = [
    'PATH/TO/ORG/FILE-1.org',
    'PATH/TO/ORG/FILE-2.org',
    # and more...
]

For more options available, see orgviz/default_config.py.

Development

To run from source, use the following commands. You need coffee, wget, unzip, make and git commands. Also, all the dependencies (see below) must be importable.:

git clone git://github.com/tkf/orgviz.git
cd orgviz
make build
python -m orgviz.cli serve [OPTIONS]

To run automated testing, run the following command. You need the tox command line tool:

make test

Dependencies

Optional dependencies:

Dependencies for build and test include:

License

OrgViz is licensed under the terms of the MIT license (see COPYING).

OrgViz bundles libraries with the following licenses.

 
File Type Py Version Uploaded on Size
orgviz-0.0.1.dev0.tar.gz (md5) Source 2012-10-28 159KB
  • Downloads (All Versions):
  • 2 downloads in the last day
  • 16 downloads in the last week
  • 136 downloads in the last month