Skip to main content

scons build system extension

Project description

// If you are reading this in plaintext or on PyPi, checkout the rendered version
// at
== SConsider[SConsider] is a[SCons] extension to provide a recursive target detection and dependency handling mechanism.

Instead of manually tracking locations of dependent projects and files,[SConsider] will scan your directory tree for `*.sconsider` files and interpret the setting for building up the _package_ and it’s _targets_ during a later phase.
To reference a _target_ from another _package_, you can simply reference it like `SomePackage.TargetA`.

=== Install the development version into your virtualenv

Please check the[packaging] information to learn more about this topic.

==== Install

The following command installs a development version into the current virtualenv: `pip install --editable .`
If you want to omit installing dependencies, add `--no-deps` to the command.

Alternatively you can use the _old style_ command: `python develop`

==== Uninstall

To uninstall a previously installed editable version use: `pip uninstall sconsider`

In case you used the _old style_ command, you need to use the following command: `python develop --uninstall`

=== Running tests

I recommend using[tox] to execute the tests as it properly sets up the right environment.
To see a list of available test environment to execute, list them using `tox -l` and either

* run the default environment(s) `tox`
* run a specific environment `tox -e some-env`

=== Create a source/wheel package

The[packaging guide] will show you how to deploy a package and a short[guide on wheels] will explain you what wheels are.

Creating a wheel package is also handled by[tox] and the corresponding environment is `wheel`.
It will create the wheel package and if you additionally want to get a source tarball, you can add `sdist` as argument to tox like: `tox -e wheel sdist`

=== (Test-) Upload to pypi

A specific[tox] environment `upload` exists in link:tox.ini#L96[tox.ini] which can be used to either[test upload] the package or to finally upload it to[pypi].
More on this can be found[in this thread] and in the[python packaging docu].

In order to run this environment, a `~/.pypirc` containing at least the following sections must exist and you need to register on both sites:

index-servers =
#recommended to leave default

Issue the following command to test the package, `testpypi` is the default upload location:

tox -e upload

or use the following to finally upload it to[pypi]:

PYPI_REPO_NAME=pypi tox -e upload

To use a different[pypi] `rc` file, use `PYPIRC_LOCATION=/path/to/pypirc` prefix to the previous commands.

=== Overview of available `` commands

To get an overview of available commands use:

python --help-commands

Help regarding a specific command can be retrieved using:

python <command> --help

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

SConsider-0.3.21.tar.gz (141.3 kB view hashes)

Uploaded source

Built Distribution

SConsider-0.3.21-py2-none-any.whl (159.3 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page