Welcome to Moic’s documentation!

Command line utility to interact with issue manager such as Jira, Gitlab, etc…

Highlights

  • Modern CLI based on Click and Rich
  • Context management
  • Multiple tracker plugin
  • Uniformed display

Getting Started

  • Install moic
> pip install moic
  • Configure moic
> moic configure
  • Commands
> moic
Usage: moic [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  config    Configure Jira cli, setting up instance, credentials etc...
  issue     Create, edit, list Jira issues
  rabbit    Print an amazing rabbit: Tribute to @fattibenji...
  resources List projects, issue_types, priorities, status
  sprint    Create, edit, list Jira Sprints
  template  List, edit templates
  version   Provide the current moic installed version

Autocompletion

To activate bash autocompletion just add: * For bash

# In your .bashrc
eval "$(_MOIC_COMPLETE=source_bash moic)"
  • For zsh
# In your .zshrc
eval "$(_MOIC_COMPLETE=source_zsh moic)"

Contribute

Feel free open issues on Gitlab or propose Merge Requests

Prerequisites

This project is based on Poetry as a package manager. It allows the use of virtual environments and the lock of package versions, whether they are in your dependencies or just sub-dependencies of these dependencies.

Setup

  • Create virtualenv (Optionnaly you can use pyenv which is a Python Virtualenv Manager in combination with Poetry)
poetry shell
  • Install dependencies
poetry install

pre-commit install
Pre-commit will check isort, black, flake8

### Commit messages

This project uses semantic versioning so it is important to follow the rules of conventional commits.

Contents: