https://github.com/osechet/bld
A project build helper
https://github.com/osechet/bld
build build-helper helper project
Last synced: 5 months ago
JSON representation
A project build helper
- Host: GitHub
- URL: https://github.com/osechet/bld
- Owner: osechet
- License: mit
- Created: 2017-10-15T15:49:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T15:35:35.000Z (over 3 years ago)
- Last Synced: 2026-01-03T18:55:52.581Z (6 months ago)
- Topics: build, build-helper, helper, project
- Language: Python
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bld
[](https://travis-ci.org/osechet/bld)
[](https://codecov.io/gh/osechet/bld)
Bld (pronouced /bɪld/ as build) is a project build helper. It is mainly aimed at complex project composed by modules with different languages.
A typical project example is a client/server project where the server is coded with one language (C++, Go, Python...) and the client in another (Java, Javascript...). Both modules uses their own build system that can rarely be the same. To build the whole project, you end by creating a lot of scripts that cover the main situations.
Bld can be used to avoid the creation of all those scripts. Just create a Python module for each project's module where you describe how to build it.
## Installation
* From source:
```bash
git clone https://github.com/osechet/bld
cd bld
python setup.py install
```
## Usage
* At the root of your project, create a `projectfile.py` file:
```python
"""
Project definition.
"""
NAME = 'super-project'
VERSION = '0.1.0-dev'
MODULES = ['client', 'server']
BUILD_DIR = 'build'
```
* Set the `PROJECT_HOME` environment variable to define the root directory of your project:
```bash
export PROJECT_HOME="/path/to/super-project"
```
* Create a script for each project module in the `${PROJECT_HOME}/bld` directory:
client.py:
```python
"""
The client module.
"""
import os
def build(project, args):
"""
Build the module.
"""
# Aliases
run = project.run
module_dir = os.path.join(project.root_dir, 'client')
with project.chdir(module_dir):
with project.step('client:build', "Build"):
run('echo "Building..."')
run('sleep 2')
```
server.py:
```python
"""
The server module.
"""
import os
import platform
def build(project, args):
"""
Build the module.
"""
# Aliases
run = project.run
module_dir = os.path.join(project.root_dir, 'server')
with project.chdir(module_dir):
with project.step('server:build', "Build"):
run('echo "Building..."')
run('sleep 3')
```
* Call `bld` to build the whole project or `bld ` to build a specific module.
### Reports
Bld automatically monitor the time execution of the build. The result is stored at the end of the build in the `reports/time.csv` file. The project's `step()` method can be used to monitor a specific block of code. The time report list all the executed steps by name but also the total build execution:
```csv
client:build,server:build,total
2.015258717990946,3.018017319991486,5.0884078509989195
```
## Development
Note: It is advised to work inside a virtual environment. In this section, we'll work with venv.
* Create the virtual environement:
```bash
python3 -m venv ./venv
```
* Later to open the virtual environment:
```
. ./venv/bin/activate
```
* Install requirements (once in virtual environment):
```bash
python -m pip install -r requirements.txt
python -m pip install -r requirements_dev.txt
```
* Run the `bld` command:
```bash
./bldlib/bld.py -h
```
### Unit tests
To run unit tests, call `pytest`. For code coverage, run `pytest --cov=bldlib`.
### Tests
To install the package being developed, run `pip install -e .` from the project's root directory. You can then uninstall it with `pip uninstall bld`.
### Publishing
```bash
rm -rf dist
python setup.py sdist
twine upload dist/*
```