Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 2.86 KB

index.rst

File metadata and controls

105 lines (77 loc) · 2.86 KB
Raw

Yabs

Test, Build, Deliver!

Build Status |nbsp| PyPI Version |nbsp| License |nbsp| Documentation Status |nbsp| Coverage Status |nbsp| Code style: black |nbsp| StackOverflow: yabs

Project:https://github.com/mar10/yabs/
Version:|version|, Date: |today|

Warning

Yabs has currently beta status.

.. toctree::
   :hidden:

   Overview<self>
   installation
   user_guide.md
   reference_guide
   development
   changes

Yabs is a command line tool, that runs a sequence of tasks in order to test, build, and deliver a Python software project.

../teaser.png

Features

  • Define a custom workflow definition using YAML syntax.
  • Check preconditions to prevent unwanted or failing releases.
  • Run external tools like linters and check their return values.
  • Bump version number in Python or text files.
  • Create source and built distributions by running setup.py.
  • Tag, commit, and push to git repository.
  • Publish releases on PyPI or GitHub.
  • Comes with prebuilt activities, but can be extended by custom task-plugins.
  • This is a command line tool that runs on Linux, macOS, and Windows...
  • ... and a library for use in custom Python projects.

Quickstart

Releases are hosted on PyPI and can be installed using pipenv (Python 3.5+ is required)

$ pipenv shell
(yabs) $ pipenv install yabs --upgrade
(yabs) $ yabs --version -v
(yabs) $ yabs --help
(yabs) $ yabs run --inc patch