Merge pull request #19 from toggle-corp/feature/add-typings

Change argparse to tap

Author: AdityaKhatri

README.md

@@ -1,86 +1,60 @@
 # Alacritty Colorscheme
 
-Change colorscheme of alacritty with ease.
-
-![Usage](https://user-images.githubusercontent.com/4928045/38159826-c451861a-34d0-11e8-979b-34b67027fb87.gif)
-
-## Usage
-
-```
-usage: alacritty-colorscheme [-h] (-s | -l | -a colorscheme | -t colorschemes [colorschemes ...] | -T) [-r] [-c configuration file] [-C colorscheme directory] [-V]
+![PyPI](https://img.shields.io/pypi/v/alacritty-colorscheme) ![PyPI - Downloads](https://img.shields.io/pypi/dm/alacritty-colorscheme)
 
 Change colorscheme of alacritty with ease.
 
-optional arguments:
-  -h, --help            show this help message and exit
-  -s, --show-applied    Show applied colorscheme
-  -l, --list-available  List available colorschemes
-  -a colorscheme, --apply colorscheme
-                        Apply colorscheme
-  -t colorschemes [colorschemes ...], --toggle colorschemes [colorschemes ...]
-                        Toggle colorschemes
-  -T, --toggle-available
-                        Toggle all available colorschemes
-  -r, --reverse-toggle  Toggle through colorschemes in reverse order
-  -c configuration file, --config-file configuration file
-                        Path to configuration file
-  -C colorscheme directory, --colorscheme-directory colorscheme directory
-                        Path to colorscheme directory
-  -V, --base16-vim      Support base16-vim
-```
+![Usage](https://user-images.githubusercontent.com/4928045/106160031-8267a880-61ad-11eb-9acf-b9d5cd5de3e4.gif)
 
 ## Installation
 
-You can install it from pip:
+You can install alacritty-colorscheme using pip:
 
 ```bash
 pip install --user alacritty-colorscheme
 ```
 
-## Running locally
-
-```bash
-# Install poetry
-pip install --user poetry
-
-# Get program
-git clone https://github.com/toggle-corp/alacritty-colorscheme.git
+## Usage
 
-# Run program
-cd alacritty-colorscheme
-poetry install
-poetry run python alacritty_colorscheme/cli.py
+```
+usage: alacritty-colorscheme [-c configuration file] [-C colorscheme directory] [-V] [-h]
+                             {list,status,toggle,apply} ...
 ```
 
-## Getting themes
+## Getting colorschemes
 
-You can get themes from [aaron-williamson/base16-alacritty](https://github.com/aaron-williamson/base16-alacritty)
+- You can get colorschemes from [aaron-williamson/base16-alacritty](https://github.com/aaron-williamson/base16-alacritty)
 
-```bash
-DEST="$HOME/.aaron-williamson-alacritty-theme"
+    ```bash
+    REPO="https://github.com/aaron-williamson/base16-alacritty.git"
+    DEST="$HOME/.aarors-williamson-colorschemes"
 
-# Get themes
-git clone https://github.com/aaron-williamson/base16-alacritty.git $DEST
-```
+    # Get colorschemes 
+    git clone $REPO $DEST
+    # Create symlink at default colors location (optional)
+    ln -s "$DEST/colors" "$HOME/.config/alacritty/color"
+    ```
 
-You can alternatively get themes from from [eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
+- You can also get colorschemes from from [eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
 
-```bash
-DEST="$HOME/.eendroroy-alacritty-theme"
+    ```bash
+    REPO=https://github.com/eendroroy/alacritty-theme.git
+    DEST="$HOME/.eendroroy-colorschemes"
+    # Get colorschemes
+    git clone $REPO $DEST
+    # Create symlink at default colors location (optional)
+    ln -s "$DEST/themes" "$HOME/.config/alacritty/color"
+    ```
 
-# Get themes
-git clone https://github.com/eendroroy/alacritty-theme.git $DEST
-```
-
-## Synchronizing with vim/neovim
+## Sync with vim/neo-vim
 
 If you are using base16 colorschemes from
-[base16-vim](https://github.com/chriskempson/base16-vim), you can use the `-V`
-argument to generate `~/.vimrc_background` file when you change alacritty
-colorscheme.
+[base16-vim](https://github.com/chriskempson/base16-vim) plugin, you can use
+the `-V` argument to automatically generate `~/.vimrc_background` file when you
+change alacritty colorscheme. You will need to source this file in your vimrc
+to load the same colorscheme in vim.
 
-You will need to source the file in your vimrc to load the appropriate
-colorscheme in vim. Add the following in your vimrc file:
+Add this in your `.vimrc` file:
 
 ```vim
 if filereadable(expand("~/.vimrc_background"))
@@ -89,63 +63,61 @@ if filereadable(expand("~/.vimrc_background"))
 endif
 ```
 
-After changing alacritty colorscheme, you need to simply reload your vimrc
-configuration.
+When you change your alacritty colorscheme, you simply need to source
+`~/.vimrc_background` or your `vimrc`.
+If you are a neo-vim user, `~/.vimrc_background` will be automatically sourced.
 
-### Reloading neovim
+## Examples
 
-If you are using neovim, you can use
-[neovim-remote](https://github.com/mhinz/neovim-remote) to reload the nvim
-sessions externally.
+### bash/zsh aliases
 
-Install neovim-remote:
+Add this in your `.zshrc` or `.bashrc` file:
 
 ```bash
-pip install --user neovim-remote
-```
-
-Reload a neovim session using:
+LIGHT_COLOR='base16-gruvbox-light-soft.yml'
+DARK_COLOR='base16-gruvbox-dark-soft.yml'
 
-```bash
-nvr -cc "source ~/.config/nvim/init.vim"
+alias day="alacritty-colorscheme -V apply $LIGHT_COLOR && reload_nvim"
+alias night="alacritty-colorscheme -V apply $DARK_COLOR && reload_nvim"
+alias toggle="alacritty-colorscheme -V toggle $LIGHT_COLOR $DARK_COLOR && reload_nvim"
 ```
 
-## Example bash/zsh configuration (base16-vim + neovim + neovim-remote)
+### i3wm/sway bindings
 
-You can add this example configuration in your .zshrc or .bashrc to switch
-between dark and light theme.
-This snippet creates two aliases namely: `day`, `night`
+Add this in your i3 `config` file:
 
 ```bash
-function reload_nvim {
-    for SERVER in $(nvr --serverlist); do
-        nvr -cc "source ~/.config/nvim/init.vim" --servername $SERVER &
-    done
-}
+set $light_color base16-gruvbox-light-soft.yml
+set $dark_color base16-gruvbox-dark-soft.yml
 
-COLOR_DIR="$HOME/.aaron-williamson-alacritty-theme/colors"
-LIGHT_COLOR='base16-gruvbox-light-soft.yml'
-DARK_COLOR='base16-gruvbox-dark-soft.yml'
+# Toggle between light and dark colorschemes
+bindsym $mod+Shift+n exec alacritty-colorscheme -V toggle $light_color $dark_color
+
+# Toggle between all available colorschemes
+bindsym $mod+Shift+m exec alacritty-colorscheme -V toggle
 
-alias day="alacritty-colorscheme -C $COLOR_DIR -a $LIGHT_COLOR -V && reload_nvim"
-alias night="alacritty-colorscheme -C $COLOR_DIR -a $DARK_COLOR -V && reload_nvim"
+# Get notification with current colorscheme
+bindsym $mod+Shift+b exec notify-send "Alacritty Colorscheme" `alacritty-colorscheme status`
 ```
 
-## Example i3wm/sway configuration
+## Development
+
+### Running locally
 
 ```bash
-set $color_dir $HOME/.aaron-williamson-alacritty-theme/colors
-set $light_color base16-gruvbox-light-soft.yml
-set $dark_color base16-gruvbox-dark-soft.yml
+pip install --user poetry
+
+git clone https://github.com/toggle-corp/alacritty-colorscheme.git
+cd alacritty-colorscheme
 
-# Toggle between light and dark colorscheme
-bindsym $mod+Shift+n exec alacritty-colorscheme -C $color_dir -t $light_color $dark_color
+poetry install
+poetry run python -m alacritty_colorscheme.cli
+```
 
-# Toggle between all available colorscheme
-bindsym $mod+Shift+m exec alacritty-colorscheme -C $color_dir -T
+### Installing locally
 
-# Get notification with current colorscheme
-bindsym $mod+Shift+b exec notify-send "Alacritty Colorscheme" `alacritty-colorscheme -C $color_dir -s`
+```bash
+pip install --user .
 ```
 
 ## License

alacritty_colorscheme/__init__.py

@@ -1 +1 @@
-__version__ = '0.2.0'
+__version__ = '0.2.1'