scons-tool-gnuplot

Gnuplot tool for scons. For tarball and documentation see project page at sourceforge.net.

INSTALLATION

There are few ways to install this tool for your project.

From pypi

This method may be preferable if you build your project under a virtualenv. To add gnuplot tool from pypi, type (within your wirtualenv):

pip install scons-tool-loader scons-tool-gnuplot

or, if your project uses pipenv:

pipenv install --dev scons-tool-loader scons-tool-gnuplot

Alternatively, you may add this to your Pipfile

[dev-packages]
scons-tool-loader = "*"
scons-tool-gnuplot = "*"

The tool will be installed as a namespaced package sconstool.gnuplot in project's virtual environment. You may further use scons-tool-loader to load the tool.

As a git submodule

1. Create new git repository:

   mkdir /tmp/prj && cd /tmp/prj
   touch README.rst
   git init

2. Add the scons-tool-gnuplot as a submodule:

   git submodule add git://github.com/ptomulik/scons-tool-gnuplot.git site_scons/site_tools/gnuplot

3. For python 2.x create __init__.py in site_tools directory:

   touch site_scons/site_tools/__init__.py

   this will allow to directly import site_tools.gnuplot (this may be required by other tools).

REQUIREMENTS

To perform certain activities, you may need the following packages (listed per task).

To generate API documentation

• epydoc,
• python-docutils,
• python-pygments.

To generate user documentation

• docbook-xml,
• xsltproc,

GENERATING DOCUMENTATION

Scons gnuplot tool has an API documentation and user manual. The documentation may be generated as follows (see also REQUIREMENTS).

API documentation

Before generating API docs, you should install our module in edit mode:

pipenv run pip install -e .

To generate API documentation type:

pipenv run scons api-doc

The generated API documentation will be written to build/doc/api/. Note, that API doc generator (epydoc) works only with python2.

User manual

To generate user manual type:

pipenv run scons user-doc

The generated documentation will be written to build/doc/user/.

LICENSE

Copyright (c) 2013-2020 by Paweł Tomulik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE