https://github.com/ptomulik/scons-common-arguments
Commonly used CLI arguments in SCons
https://github.com/ptomulik/scons-common-arguments
Last synced: 3 months ago
JSON representation
Commonly used CLI arguments in SCons
- Host: GitHub
- URL: https://github.com/ptomulik/scons-common-arguments
- Owner: ptomulik
- Created: 2016-02-12T02:03:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-19T23:06:40.000Z (over 8 years ago)
- Last Synced: 2025-01-18T02:28:39.262Z (5 months ago)
- Language: Python
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
scons-common-arguments
======================
| travis-ci | appveyor | coveralls |
|-----------|-----------|-----------|
|[](https://travis-ci.org/ptomulik/scons-common-arguments)| [](https://ci.appveyor.com/project/ptomulik/scons-common-arguments) | [](https://coveralls.io/github/ptomulik/scons-common-arguments?branch=master) |
Welcome to ``scons-common-arguments``.
The scons-common-arguments package is an extension to SCons which provides
several predefined command-line variables and options for SCons scripts. An
amount of common command line options/variables may be added to SCons with just
few lines of code.
**NOTE**: you'll also need [scons-arguments](https://github.com/ptomulik/scons-arguments)
INSTALLATION
------------
There are two method for installation:
### Installation by simple copy
Copy recursively ``SConsCommonArguments/`` to your ``site_scons/`` directory
cp -r scons-common-arguments/SConsCommonArguments your/projects/site_scons/
### Installation as a submodule in git-based projects
Add the repository as a submodule to your project
```shell
git submodule add git://github.com/ptomulik/scons-common-arguments.git 3rd/scons-common-arguments
```
In your `site_scons/site_init.py` add the following lines:
```python
# site_scons/site_init.py
import sys
sys.path.append(Dir('#3rd/scons-common-arguments').abspath)
```
DOCUMENTATION
-------------
### User documentation
Online User Manual may be found at:
*
User documentation can be generated from the top level directory with the
following command (see also requirements below)
```shell
scons user-doc
```
The generated documentation is located in ``build/doc/user``.
### API documentation
Online API documentation may be found at:
*
API documentation can be generated from the top level directory with the
following command (see also requirements below)
```shell
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
* xsltproc
* imagemagick
You also must install locally the SCons docbook tool by Dirk Baechle:
* scons docbook tool
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
* python-docutils
* python-pygments
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.
```shell
apt-get install python-epydoc python-docutils python-pygments
```
TESTING
-------
We provide unit tests and end-to-end tests.
### Requirements for tests
* scons-arguments
Download and install it locally with
```shell
python ./bin/downloads.py scons-arguments
```
or just
```shell
python ./bin/downloads.py
```
### Running unit tests
To run unit tests type
```shell
scons unit-test
```
### Requirements for unit tests
* python-unittest2
* python-mock
On Debian install them with:
```shell
apt-get install python-unittest2 python-mock
```
### Running end-to-end tests
To run end-to-end tests, type
```shell
scons test
```
End-to-end tests are stored under ``test/`` directory. To run particular test
type (on Linux):
```shell
SCONS_EXTERNAL_TEST=1 python runtest.py test/SConsCommonArguments/UserManual/sconstest-usermanual-example1.py
```
### Requirements for end-to-end tests
* SCons testing framework
Download the SCons testing framework with:
```shell
python ./bin/downloads.py scons-test
```
or
```shell
python ./bin/downloads.py
```
LICENSE
-------
Copyright (c) 2016 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