show directory description when ls.
Project description
ls-Improved: descriptive ls-like-command working on Python.
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.
Now we have the ls-Improved(lsi) command here. It allows us to see list of directories with its descriptions simultaneously.
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.
- download latest manual version from github release.
wget https://github.com/ShotaroKataoka/ls-Improved/archive/v0.3.0.beta1.manual.zip
- unzip downloaded zip file.
- set PATH environment to
bin/
directory.
(set PATH to unzipedbin/
directory or placebin/lsi
andbin/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'
: makeDIRECTORY
and writeDESCRIPTION
into.description.lsi
mkdiri DIRECTORY
: makeDIRECTORY
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
lsi
lsi
print out directory structure with .description.lsi
content.
lsi
: Show directory structure and these descriptions in the current directorylsi DIRECTORY
: Show directory structure and these descriptions in theDIRECTORY
lsi -a
: Show hidden files and directorieslsi -F
: Show only fileslsi -D
: Show only directorieslsi -s 'SEARCH_WORD'
: search file-name and description withSEARCH_WORD
Related projects
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for ls_Improved-0.3.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec06b7974212789ec07ab01e25fb36202ea8e75e8f454d167c756657e3832813 |
|
MD5 | ea83a503f8b6ad648ce16cf49421d61d |
|
BLAKE2b-256 | 322acd7eb71b00ca2c4aea864de32533f7dadce2c5d78ab32a5f49ca1b1e3b9c |