Metadata-Version: 2.1
Name: ls-Improved
Version: 0.3.0b2
Summary: show directory description when ls.
Home-page: https://github.com/ShotaroKataoka/ls-Improved
Author: Shotaro Kataoka
Author-email: shotaro.kata@gmail.com
License: MIT
Keywords: ls,filer,command,mkdir,utils
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7
Description-Content-Type: text/markdown

# ls-Improved: descriptive ls-like-command working on Python.
[![Downloads](https://pepy.tech/badge/ls-improved)](https://pepy.tech/project/ls-improved)  

[日本語README](https://github.com/ShotaroKataoka/ls-Improved/blob/master/README.ja.md)

## What is it?
**ls-Improved (lsi)** prints out a directory structure with its descriptions. 
I've been using it when tackling some seriese of experiments.(e.g. machine leaning experiments.)  

### Example
We have some directories like below.  
Sometimes we'd like to access a best result of experiment, but it is not easy.  It is necessary to open all of directories or note `experiments_summary.txt` beforehand in order to do it.  

![ls](https://github.com/ShotaroKataoka/ls-Improved/blob/master/doc/images/ls_using.png)

Now we have the **ls-Improved(lsi)** command here.  It allows us to see list of directories with its descriptions simultaneously.  

![lsi](https://github.com/ShotaroKataoka/ls-Improved/blob/master/doc/images/lsi_using.png)

## Requirements
developed on Python2.7 and Python3.7 (maybe ≧Python2.7 is ok.)  
It is working on Python, so this command dose not depend on OS.  

## Install
### pip install
```
# PyPI
pip install ls-Improved
```

### manual install
**This way is not supported now.**  
For person who do not like PyPI, manual install version exists.  

1. download latest manual version from github release.  
`wget https://github.com/ShotaroKataoka/ls-Improved/archive/v0.3.0.beta1.manual.zip`  
2. unzip downloaded zip file.  
3. set PATH environment to `bin/` directory.  
(set PATH to unziped `bin/` directory or place `bin/lsi` and `bin/mkdiri` to `/usr/local/bin/` )  

## Usage
### How works
`lsi` read `.description.lsi` files which are in each directories.  
`.description.lsi` is simple text file.  It is made by `mkdiri` command.  

**In brief:**
- `mkdiri` make a directory with the `.description.lsi` text file.
- `lsi` print out directory structure with `.description.lsi` content.

### mkdiri
`mkdiri` make a directory with the `.description.lsi`.
- `mkdiri DIRECTORY 'DESCRIPTION'` : make `DIRECTORY` and write `DESCRIPTION` into `.description.lsi`  
- `mkdiri DIRECTORY` : make `DIRECTORY` and create empty `.description.lsi`  
- `mkdiri -a DIRECTORY DESCRIPTION` : overwrite or create `.description.lsi` in existing directory.  

**tips:**  
Add decoration to description :  
- `\n` : make new line
- `;r;` `;g;` `;b;` `;w;` `;p;` : add color to text
- `;_;` : add underline to text
- `;e;` : end decoration

**Example**  
![mkdiri_decoration](https://github.com/ShotaroKataoka/ls-Improved/blob/master/doc/images/mkdiri_decoration.png)  

### lsi
`lsi` print out directory structure with `.description.lsi` content.  
- `lsi` : Show directory structure and these descriptions in the current directory
- `lsi DIRECTORY` : Show directory structure and these descriptions in the `DIRECTORY`
- `lsi -a` : Show hidden files and directories
- `lsi -F` : Show only files
- `lsi -D` : Show only directories
- `lsi -s 'SEARCH_WORD'` : search file-name and description with `SEARCH_WORD`

## Related projects
- [Emacs client](https://github.com/conao3/dired-lsi.el) by [conao3](https://github.com/conao3)


