scons-gnu-arguments

travis-ci	appveyor	coveralls

Welcome to scons-gnu-arguments.

The scons-gnu-arguments package is an extension to SCons which provides several predefined command-line variables and options for SCons scripts that are used to build GNU-like software. Add the whole amount of standard GNU command line options/variables to SCons may be done with just few lines of code.

NOTE: you'll also need scons-arguments

INSTALLATION

There are two method for installation:

Installation by simple copy

Copy recursively SConsGnuArguments/ to your site_scons/ directory

cp -r scons-gnu-arguments/SConsGnuArguments your/projects/site_scons/

Installation as a submodule in git-based projects

Add the repository as a submodule to your project

git submodule add git://github.com/ptomulik/scons-gnu-arguments.git 3rd/scons-gnu-arguments

In your site_scons/site_init.py add the following lines:

# site_scons/site_init.py
import sys
sys.path.append(Dir('#3rd/scons-gnu-arguments').abspath)

DOCUMENTATION

User documentation

Online User Manual may be found at:

• http://ptomulik.github.io/scons-gnu-arguments/user/manual.html

User documentation can be generated from the top level directory with the following command (see also requirements below)

scons user-doc

The generated documentation is located in build/doc/user.

API documentation

Online API documentation may be found at:

• http://ptomulik.github.io/scons-gnu-arguments/api/

API documentation can be generated from the top level directory with the following command (see also requirements below)

scons api-doc

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

Requirements for user-doc

To generate user's documentation, you'll need following packages on your system:

• docbook5-xml http://www.oasis-open.org/docbook/xml/
• xsltproc ftp://xmlsoft.org/libxslt/
• imagemagick http://www.imagemagick.org/

You also must install locally the SCons docbook tool by Dirk Baechle:

• scons docbook tool https://bitbucket.org/dirkbaechle/scons_docbook/

this is easily done by running the following bash script

python bin/downloads.py scons-docbook

or simply (to download all dependencies)

python bin/downloads.py

from the top level directory.

Requirements for api-doc

To generate API documentation, you may need following packages on your system:

• python-epydoc http://epydoc.sourceforge.net/
• python-docutils http://pypi.python.org/pypi/docutils
• python-pygments http://pygments.org/

Note, that epydoc is no longer developed, last activities in the project are dated to 2008. The pip epydoc package 3.0.1 is not usable with current versions of python. Fortunately Debian package is patched to work with current python. Please use the python-epydoc package installed with apt-get.

apt-get install python-epydoc python-docutils python-pygments

TESTING

We provide unit tests and end-to-end tests.

Requirements for tests

• scons-arguments https://github.com/ptomulik/scons-arguments

Download and install it locally with

python ./bin/downloads.py scons-arguments

or just

python ./bin/downloads.py

Running unit tests

To run unit tests type

scons unit-test

Requirements for unit tests

• python-unittest2 https://pypi.python.org/pypi/unittest2
• python-mock https://pypi.python.org/pypi/mock

On Debian install them with:

apt-get install python-unittest2 python-mock

Running end-to-end tests

To run end-to-end tests, type

scons test

End-to-end tests are stored under test/ directory. To run particular test type (on Linux):

SCONS_EXTERNAL_TEST=1 python runtest.py test/SConsGnuArguments/UserManual/sconstest-usermanual-example1.py

Requirements for end-to-end tests

• SCons testing framework

Download the SCons testing framework with:

python ./bin/downloads.py scons-test

or

python ./bin/downloads.py

LICENSE

Copyright (c) 2015 by Pawel 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