Welcome to Easy graphviz’s documentation!

Contents:

Easy graphviz

https://img.shields.io/pypi/v/easygv.svg https://img.shields.io/travis/xguse/easygv.svg Documentation Status Updates

Define nodes and edges in an excel file and graph-style attributes in a yaml file with inheritence.

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install Easy graphviz, run this command in your terminal:

$ pip install easygv

This is the preferred method to install Easy graphviz, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Easy graphviz can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/xguse/easygv

Or download the tarball:

$ curl  -OL https://github.com/xguse/easygv/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

Import into a project

You can import the package as follows:

from easygv import easygv

The command line tool

Base command help text

$ easygv --help

Usage: easygv [OPTIONS] COMMAND [ARGS]...

  Command interface to easygv.

  Define nodes and edges in an excel file and graph-style attributes in a
  yaml file with inheritence.

  For command specific help text, call the specific command followed by the
  --help option.

Options:
  -v, --verbosity [debug|normal|quiet]
                                  How much do you want to know about what I am
                                  doing?  [default: normal]
  --help                          Show this message and exit.

Commands:
  config  Manage configuration values and files.
  draw    Draw and save your graph.

Dealing with configuration files

$ easygv config --help

Usage: easygv config [OPTIONS]

  Manage configuration values and files.

Options:
  -g, --generate-config  Copy one or more of the 'factory default' config
                         files to the users config directory
                         (/home/gus/.config/easygv). Back ups will be made of
                         any existing config files.  [default: False]
  -k, --kind [attrs]     Which type of config should we replace?  [default:
                         attrs]
  -p, --prefix TEXT      A prefix to identify the new config file(s).
  --help                 Show this message and exit.

Drawing your graphs

$ easygv draw --help

Usage: easygv draw [OPTIONS] DEFINITION ATTR_CONFIG

  Produce your graph and save results based on your input.

  DEFINITION  = Excel file containing the definition of your nodes and edges
  ATTR_CONFIG = YAML file containing the attribute information for your
                graph, node-, and edge-types

Options:
  -f, --formats [all|pdf|png|svg]
                                  Which type of format should we produce?
                                  [default: all]
  -d, --directory DIRECTORY       Path to a directory to write out the files.
  -n, --name TEXT                 A name for your figure.
  -l, --layout [dot|neato|fdp|sfdp|twopi|circo]
                                  Which layout program?  [default: dot]
  --help                          Show this message and exit.

Source Code Documentation

easygv package

Subpackages

easygv.cli package
Submodules
easygv.cli.config module
Module contents

Submodules

easygv.easygv module

Module contents

Top-level package for Easy graphviz.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/xguse/easygv/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Easy graphviz could always use more documentation, whether as part of the official Easy graphviz docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/xguse/easygv/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up easygv for local development.

  1. Fork the easygv repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/easygv.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv easygv
$ cd easygv/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 easygv tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/xguse/easygv/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_easygv

Credits

Development Lead

Contributors

None yet. Why not be the first?

v0.1.1 / 2017-12-18

  • config pyup to send PRs every month not day
  • pinned all reqs since pyup managed now
  • dependency updates
  • Pin pylama to latest version 7.4.3

v0.1.0 / 2017-09-07

  • tests more robust
  • Makefile: docs -> dont run apidoc as command
  • add_edges now supports edge labels and classes
  • easygv: added and improved docstrings
  • supports clusters
  • load_graph_input: now recodes NaNs to “”
  • configure flake8 ignores ignore flake8 D301 in certain functions flake8 ignore all E501, D413
  • easygv.cli: removed unused imports
  • inform that we only support py34 to py36
  • Fleshed out usage.rst

v0.0.2 / 2017-08-28

  • docs/index.rst fixed title warning
  • delete cli.draw
  • add sphinx_rtd_theme as dev dep
  • tox.ini removed py2k added py36
  • first minimally functional commit
  • docs/conf.py set run_apidoc module_path
  • ran travis_pypi_setup.py
  • ignore tmp/

v0.0.1 (2017-08-25)

  • Initial commits.

Indices and tables