Nodepile

IMPORTANT NOTE - THIS IS NOT WORKING CODE

Nodepile is a tool for converting tabular data in flat text files (such as CSV, TSV, etc.) and manipulating their appearance and composition for presentation using the Graphviz family of open source image renderers. That sounds complex but it is meant to be an easy way to "visualize" pre-existing spreadsheet data in the form of nodes and edges.

As a general structure, it reads in one or more tabular "flat files" representing a list of nodes, edges, and styles. It can then output spec files in the DOT language used by Graphviz. If Graphviz is installed on the system, it can be used to drive Graphviz to generate fully rendered image output. Additional facilitities support manipulation of the nodes, edges, and styles as well as output of intermediate results as human editable (but hairy) text files.

The tabular input files are intended to be extremely tolerant including allowing for columns of pre-existing data to remain associated to edges and nodes and for styling to be conditional based on those pre-existing columns of data.

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nodepile.