view org-mode files from different directions
Project description
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.
jQuery : MIT or GPL v2 license
FullCalendar : MIT or GPL v2 license
jQuery Hotkeys : MIT or GPL v2 license
ColorBox : MIT license
Nuvola: LGPL v2.1
Links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file orgviz-0.0.1.dev0.tar.gz
.
File metadata
- Download URL: orgviz-0.0.1.dev0.tar.gz
- Upload date:
- Size: 163.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 925ba80bb15c334fdf1b5cd6291a3556d3320e0820f7ca86531ff0ec9c3d26b2 |
|
MD5 | 2e6915da56820021402cb430d20650f5 |
|
BLAKE2b-256 | fc5810c2ead946200909ca41d0fc41538352ce1d89bc4e5050f6d3f6e1563dce |