Project automation the Apiary way¶
This is an internal tool for supporting development workflow inside Apiary. However, we decided to open-source it. Feel free to fork it and use it on your own or inside your company.
On macOS, the easiest way to install blackbelt is via Homebrew:
$ brew install apiaryio/formulae/blackbelt
On other platforms you can install Blackbelt with
pip install blackbelt providing you have Python and pip installed. Consult your platform for documentation on how to install Python and pip.
Python 3.6+ is default now and Python 2.7 will be deprecated.
With that, you should have
bb command. Run interactive
bb init and follow instructions. This is going to connect to services we are using in Apiary for futher interaction:
Retrieved tokens and configuration is stored in
~/.blackbelt. Format is now just dumped JSON, don’t rely on it; it’s probably going to change in the future.
If you are using
bash, you want to enable autocompletion. You can try it with:
eval "$( _BB_COMPLETE=source bb)"
and if it’s working properly, put it into your
echo '_BB_COMPLETE=source bb > /tmp/_black_belt_autocompletion.sh' >> ~/.bashrc echo 'source /tmp/_black_belt_autocompletion.sh' >> ~/.bashrc
See click’s documentation for more information.
If you used Homebrew on macOS, use:
$ brew update $ brew upgrade
$ pip install -U blackbelt
If you get error along the lines of:
OSError: [Errno 1] Operation not permitted: '/tmp/pip-IYiPfC-uninstall/
you have a problem in your system installation (probably Mac OS X). You can either:
sudo pip install -U --ignore-installed blackbelt
pip uninstall blackbelt pip install blackbelt
bb has subcommands that stand for an area of expertise. View help or command reference on how to use those.
This documents focus more on intended workflow from the perspective of two roles (those may be the same person, of course): Developer and Story Owner.