Metadata-Version: 2.1
Name: ybt
Version: 0.3.77
Summary: Yet another Build Tool
Home-page: https://github.com/resonai/ybt
Author: Itamar Ostricher
Author-email: yabt@resonai.com
License: Apache License, Version 2.0
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Software Development :: Build Tools
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: argcomplete
Requires-Dist: colorama
Requires-Dist: ConfigArgParse
Requires-Dist: GitPython
Requires-Dist: munch
Requires-Dist: networkx (>=2.0)
Requires-Dist: ostrichlib
Requires-Dist: requests (>=2.18.0)
Requires-Dist: scandir
Requires-Dist: google-cloud-storage
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-flake8 ; extra == 'test'

[![Travis CI status](https://travis-ci.org/resonai/ybt.svg?branch=master)](https://travis-ci.org/resonai/ybt)
[![AppVeyor CI status](https://ci.appveyor.com/api/projects/status/12kdeqf4u0egjwq5/branch/master?svg=true)](https://ci.appveyor.com/project/itamaro/ybt)

YaBT: Yet another Build Tool
============================

## Install

Requires Python 3.8 or above, so make sure you have it (`type -P python3 && python3 -V`).

```sh
sudo apt-get install -y python3-dev python3-pip
sudo pip3 install --upgrade pip
sudo pip3 install ybt
```

To configure bash tab-completion, add the following line to your `.bashrc`:

```sh
eval "$(register-python-argcomplete ybt)"
```

## Development

Requires Python 3.8 or above, so make sure you have it (`type -P python3 && python3 -V`).

Recommended with [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org).

Initial virtualenv setup with virtualenvwrapper (when no virtualenv is active, run `deactivate` to make sure):

```sh
sudo apt-get install -y python3-dev python3-pip
mkvirtualenv --python="$( type -P python3 )" yabt
cd $WORKON_HOME/yabt
git clone git@github.com:resonai/ybt.git
cd ybt
# install development requirements
pip install -r requirements.txt
# install YaBT itself in local dev mode (in the virtualenv)
pip install -e .
```

You should be good to go now.

Try by running unit tests or manual test cases:

```sh
workon yabt
cd $WORKON_HOME/yabt/yabt
# Run unit tests:
make test
# Some manual tests:
cd tests/dag
ybt tree
ybt build
cd ../simple
ybt tree
# this one requires a running Docker engine,
# and the current user to be a member of the docker group
ybt build
```
