Skip to main content

A python command-line for gitmoji

Project description

gitmopy

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

pip install gitmopy

demo-gitmopy

$ 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

$ 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

$ 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.                   │
╰────────────────────────────────────────────────────────────────────────────╯

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitmopy-0.2.0.tar.gz (12.3 kB view hashes)

Uploaded Source

Built Distribution

gitmopy-0.2.0-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page