// If you are reading this in plaintext or on PyPi, checkout the rendered version
// at https://gitlab.dev.ifs.hsr.ch/ifs/sconsider/blob/master/README.adoc
== SConsider
https://gitlab.dev.ifs.hsr.ch/ifs/sconsider[SConsider] is a https://scons.org[SCons] extension to provide a recursive target detection and dependency handling mechanism.
Instead of manually tracking locations of dependent projects and files, https://gitlab.dev.ifs.hsr.ch/ifs/sconsider[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 https://packaging.python.org/distributing/#working-in-development-mode[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 setup.py 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 setup.py develop --uninstall`
=== Running tests
I recommend using http://tox.testrun.org/[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 http://python-packaging-user-guide.readthedocs.org/en/latest/tutorial.html[packaging guide] will show you how to deploy a package and a short http://wheel.readthedocs.org/en/latest[guide on wheels] will explain you what wheels are.
Creating a wheel package is also handled by http://tox.testrun.org/[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 http://tox.testrun.org/[tox] environment `upload` exists in link:tox.ini#L96[tox.ini] which can be used to either https://test.pypi.org/legacy/[test upload] the package or to finally upload it to https://pypi.org/pypi[pypi].
More on this can be found https://mail.python.org/pipermail/distutils-sig/2017-June/030766.html[in this thread] and in the https://packaging.python.org/guides/using-testpypi/#using-t[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:
[source,ini]
----
[distutils]
index-servers =
pypi
testpypi
[pypi]
#recommended to leave default
#repository:https://pypi.org/pypi
username:MyPypiUserName
password:MyPypiPass
[testpypi]
repository:https://test.pypi.org/legacy/
username:MyTestpypiUserName
password:MyTestpypiPass
----
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 https://pypi.org/pypi[pypi]:
PYPI_REPO_NAME=pypi tox -e upload
To use a different https://pypi.org/pypi[pypi] `rc` file, use `PYPIRC_LOCATION=/path/to/pypirc` prefix to the previous commands.
=== Overview of available `setup.py` commands
To get an overview of available commands use:
python setup.py --help-commands
Help regarding a specific command can be retrieved using:
python setup.py <command> --help
Metadata
Release files for SConsider 0.3.21
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| SConsider-0.3.21.tar.gz | 141.3 kB | Without provenance | Details for SConsider-0.3.21.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| SConsider-0.3.21-py2-none-any.whl | Python 2 | none | any | Details for SConsider-0.3.21-py2-none-any.whl |
Total release size: 300.6 kB
Release files / SConsider-0.3.21.tar.gz
| Download URL | SConsider-0.3.21.tar.gz |
|---|---|
| Size | 141.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6bad7601ab97d05c5e5f94093dfa91677db7427e5d315f112e164de79103053d
|
|
BLAKE2b-256 checksum How to use checksums |
a6c4dd9bf4f4cad8a9cecbcc562b2b2bdf526add67807fc9f1eab55f6e5d8c21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.6.1 requests/2.25.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/2.7.12
|
Release files / SConsider-0.3.21-py2-none-any.whl
| Download URL | SConsider-0.3.21-py2-none-any.whl |
|---|---|
| Size | 159.3 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
eec9dab3358d2c4443ee3cf9538aeeca7f3729f80ea62fc28722a304003f84c7
|
|
BLAKE2b-256 checksum How to use checksums |
e83b8da913326c883b56ff4a460b5b02fa0bcbdd292ba0e5d17c5c7fab2132c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.6.1 requests/2.25.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/2.7.12
|
Security for SConsider 0.3.21
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.