aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorrahiel <rahielkasim@gmail.com>2014-11-29 15:37:07 +0100
committerrahiel <rahielkasim@gmail.com>2014-11-29 15:37:07 +0100
commit14648109fa080e87af99eaf0fa22e2b3b69db19a (patch)
treee8cc2c1ebc1fcec312ca2b6c661c0676179b2c06
parent257d61d13b1902b79bdd1592f0ed45588a9fed0c (diff)
prepare for pypi
-rw-r--r--README.md42
-rw-r--r--setup.cfg2
-rw-r--r--setup.py19
3 files changed, 61 insertions, 2 deletions
diff --git a/README.md b/README.md
index beb81f7..3635e7d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,44 @@
shellstats
==========
-Show shell usage statistics
+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:
+
+```bash
+$ 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
new file mode 100644
index 0000000..b88034e
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
diff --git a/setup.py b/setup.py
index 4a68ced..b56989f 100644
--- a/setup.py
+++ b/setup.py
@@ -4,6 +4,13 @@ from setuptools import setup
setup(
name="shellstats",
version="0.1",
+ description="Show the most used shell commands.",
+ long_description="blabla",
+ url="https://github.com/rahiel/shellstats",
+ download_url = "https://github.com/rahiel/shellstats/tarball/0.1"
+ author="Rahiel Kasim",
+ author_email="rahielkasim@gmail.com",
+ license="MIT",
py_modules=["shellstats"],
install_requires=["click"],
entry_points={
@@ -11,5 +18,15 @@ setup(
},
extras_require = {
"Plotting": ["matplotlib"]
- }
+ },
+ classifiers=[
+ "Development Status :: 4 - Beta",
+ "Intended Audience :: End Users/Desktop",
+ "Natural Language :: English",
+ "Topic :: System :: Shells",
+ "Topic :: Utilities",
+ "License :: OSI Approved :: MIT License",
+ "Programming Language :: Python :: 2",
+ "Programming Language :: Python :: 3"
+ ]
)