Metadata-Version: 2.1
Name: gitmopy
Version: 0.2.0
Summary: A python command-line for gitmoji
License: MIT
Author: vict0rsch
Author-email: vsch@pm.me
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: GitPython (>=3.1.31,<4.0.0)
Requires-Dist: emoji (>=2.5.0,<3.0.0)
Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# gitmopy

An interactive Python implementation of the Gitmoji standard: https://gitmoji.dev/

```
pip install gitmopy
```

![demo-gitmopy](./assets/demo-gitmopy.gif)

```text
$ gitmopy info

gitmopy info:
  version : 0.1.0
  app path: /Users/victor/.gitmopy
  history : /Users/victor/.gitmopy/history.json
  config  : /Users/victor/.gitmopy/config.yaml

Current configuration:
  skip_scope      : False
  skip_message    : False
  capitalize_title: True
  enable_history  : True
```

Update configuration with

```text
$ gitmopy config
$ gitmopy config
❓ Configure gitmopy locally. Use 'space' to (de-)select, 'enter' to validate.
❯ ○ Skip commit scope
  ○ Skip commit message
  ◉ Capitalize commit title
  ◉ Remember commit history for auto-complete and emoji sorting

Config will be saved in /Users/victor/.gitmopy/config.yaml.
```

Get help with

```text
$ gitmopy --help

 Usage: gitmopy [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.    │
│ --show-completion             Show completion for the current shell, to    │
│                               copy it or customize the installation.       │
│ --help                        Show this message and exit.                  │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ commit  Commit staged files. Use --add to add all unstaged files if none   │
│         is already staged                                                  │
│ config  Configure gitmopy                                                  │
│ info    Print gitmopy info                                                 │
╰────────────────────────────────────────────────────────────────────────────╯


$ gitmopy commit --help

 Usage: gitmopy commit [OPTIONS]

 Commit staged files. Use --add to add all unstaged files if none is already
 staged

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --repo                 TEXT  Path to the git repository [default: .]       │
│ --add     --no-add           Whether or not to add all unstaged files if   │
│                              none is already staged                        │
│                              [default: no-add]                             │
│ --push    --no-push          Whether to `git push` after commit. Disabled  │
│                              by default.                                   │
│                              [default: no-push]                            │
│ --dry     --no-dry           Whether or not to actually commit.            │
│                              [default: no-dry]                             │
│ --help                       Show this message and exit.                   │
╰────────────────────────────────────────────────────────────────────────────╯
```

