diff options
| -rw-r--r-- | README.md | 28 | ||||
| -rw-r--r-- | README.rst | 50 | ||||
| -rw-r--r-- | setup.cfg | 2 | ||||
| -rw-r--r-- | setup.py | 2 |
4 files changed, 62 insertions, 20 deletions
@@ -4,26 +4,22 @@ shellstats Shellstats reads your shell history and shows you the most used commands. Typical output looks like: -``` - Command Count Percentage - 1 ls 326 17.0% - 2 cd 254 13.3% - 3 less 172 8.99% - 4 sudo 162 8.47% - 5 emacs 159 8.31% - 6 screen 146 7.63% - 7 echo 103 5.38% - 8 top 100 5.23% - 9 du 85 4.44% - 10 grep 70 3.66% - ``` + Command Count Percentage + 1 ls 326 17.0% + 2 cd 254 13.3% + 3 less 172 8.99% + 4 sudo 162 8.47% + 5 emacs 159 8.31% + 6 screen 146 7.63% + 7 echo 103 5.38% + 8 top 100 5.23% + 9 du 85 4.44% + 10 grep 70 3.66% ## Installation Install it with a simple: -```bash -$ pip install shellstats -``` + $ pip install shellstats In addition if you want to see a pie chart of the above output, you need to have matplotlib installed (package 'python-matplotlib' in Debian/Ubuntu/Fedora). diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..56f0a9d --- /dev/null +++ b/README.rst @@ -0,0 +1,50 @@ +shellstats +========== + +Shellstats reads your shell history and shows you the most used +commands. Typical output looks like: + +:: + + Command Count Percentage + 1 ls 326 17.0% + 2 cd 254 13.3% + 3 less 172 8.99% + 4 sudo 162 8.47% + 5 emacs 159 8.31% + 6 screen 146 7.63% + 7 echo 103 5.38% + 8 top 100 5.23% + 9 du 85 4.44% + 10 grep 70 3.66% + +Installation +------------ + +Install it with a simple: + +:: + + $ pip install shellstats + +In addition if you want to see a pie chart of the above output, you need +to have matplotlib installed (package 'python-matplotlib' in +Debian/Ubuntu/Fedora). + +Usage +----- + +:: + + Usage: shellstats [OPTIONS] + + Print the most frequently used shell commands. + + Options: + --n INTEGER How many commands to show. + --plot Plot command usage in pie chart. + --command TEXT Most frequent subcommands for command, e.g. sudo, git. + --history-file PATH Read shell history from history-file. + --shell TEXT Specify shell history format: bash, fish or zsh. + --help Show this message and exit. + diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index b88034e..0000000 --- a/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[metadata] -description-file = README.md @@ -1,12 +1,10 @@ from setuptools import setup - setup( name="shellstats", version="0.1", description="Show the most used shell commands.", url="https://github.com/rahiel/shellstats", - download_url = "https://github.com/rahiel/shellstats/tarball/0.1.1", author="Rahiel Kasim", author_email="rahielkasim@gmail.com", license="MIT", |