Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Build Status

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.

Metadata

Release files for orgviz 0.0.1.dev0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orgviz 0.0.1.dev0
File Size Uploaded Provenance Actions
orgviz-0.0.1.dev0.tar.gz 163.6 kB Without provenance Details for orgviz-0.0.1.dev0.tar.gz

Release files / orgviz-0.0.1.dev0.tar.gz

Download URL orgviz-0.0.1.dev0.tar.gz
Size 163.6 kB
Tags Source
SHA-256 checksum
How to use checksums
925ba80bb15c334fdf1b5cd6291a3556d3320e0820f7ca86531ff0ec9c3d26b2
BLAKE2b-256 checksum
How to use checksums
fc5810c2ead946200909ca41d0fc41538352ce1d89bc4e5050f6d3f6e1563dce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for orgviz 0.0.1.dev0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page