Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sri-csl/wholly
Wholly!
https://github.com/sri-csl/wholly
Last synced: about 2 months ago
JSON representation
Wholly!
- Host: GitHub
- URL: https://github.com/sri-csl/wholly
- Owner: SRI-CSL
- License: bsd-3-clause
- Created: 2017-07-13T17:30:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-24T18:14:12.000Z (about 7 years ago)
- Last Synced: 2024-10-28T22:15:25.391Z (about 2 months ago)
- Language: Python
- Size: 34.2 KB
- Stars: 9
- Watchers: 17
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wholly!
[](https://badge.fury.io/py/wholly)
## Overview
This project, *Wholly!*, provides a Python tool that can build clean packages in a traceable way from open-source code. We make use of Docker containers to provide a minimal and controlled build environment, clear and meaningful build "recipes" to describe precisely the dependencies and the build invocations, and fine-grained sub-packaging to release lightweight and usable images.
To achieve that, *Wholly!* provides the orchestration to build a package using a **recipe** that we try to keep as simple as possible. All the available recipies are to be stored in a local repository, or working directory.
We provide such an example working directory that is suitable to build packages for the `x86_64` architecture. Steps to use it are described below.
## Usage
### Requirements
- Python 2.7.x with `pip`
- Docker CE >= 17.05: https://www.docker.com/community-edition
### Install
You can install the latest published version via
```
pip install wholly
```
or you can check out the repository and install local development version
```
git clone https://github.com/SRI-CSL/Wholly.git
cd Wholly
make develop
```
This last step may require `sudo`.
### Fetch the Recipes
Fetch the recipes:
```
git clone https://github.com/SRI-CSL/WhollyRecipes.git
```
### Usage
We need to execute *Wholly!* from the working directory:
```
cd WhollyRecipes
```
Make sure that the Docker deamon is running by executing the Docker application. You can now build any package present into the working directory:
```
wholly build sqlite-3.18
```
This will build `sqlite-3.18` along with its dependencies. In particular, it will generate sub-packages for `sqlite-3.18`, in the form of Docker images:
```
$ docker images | grep wholly-sqlite-3.18-
wholly-sqlite-3.18-libs latest 1.34MB
wholly-sqlite-3.18-headers latest 528kB
wholly-sqlite-3.18-bin latest 1.24MB
```
### Useful options
- The `--no-cache` flag forces Docker to rebuild the packages.
- The `--nb-cores` flag is useful for some packages that support concurrent builds. The command `../Wholly/wholly.py build libcxx-4.0 --nb-cores 4`, for example, will build the package `libcxx-4.0` using 4 cores. Of course, the number of cores that you specify cannot be greater than the number of cores that you allocated to your Docker machine.
### Debugging
Wholly can show various levels of output to aid with debugging.
To show this output set the `WHOLLY_LOG_LEVEL` environment
variable to one of the following levels:
* `ERROR`
* `WARNING`
* `INFO`
* `DEBUG`
For example:
```
export WHOLLY_LOG_LEVEL=DEBUG
```
Output will be directed to the standard error stream, unless you specify the
path of a logfile via the `WHOLLY_LOG_FILE` environment variable.
For example:
```
export WHOLLY_LOG_FILE=/tmp/wholly.log
```
When the level is set to `DEBUG` the messages contain more locality information.
### Checksum Mismatches
If one is building a package and one discovers that the checksums do not match, you can either:
- Use the `--commit-all` command switch, which will replace the old checksums by the new ones.
- Use the `--ignore-checksums` command switch, which will simply ignore the mismatches (while still reporting them).
---
This material is based upon work supported by the National Science Foundation under Grant [ACI-1440800](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1440800) and Department of Homeland Security (DHS) Science and Technology Directorate. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation, the Department of Homeland Security, or the US government.