Skip to content

Commit

Permalink
Squash all commit history so that repo clones faster
Browse files Browse the repository at this point in the history
Otherwise the massive data files in the history
cause it to take forever to clone the repo. See
https://github.com/glamp/bashplotlib for the
git history.
  • Loading branch information
Greg Lamp authored and robert committed Mar 31, 2019
0 parents commit 956d0f3
Show file tree
Hide file tree
Showing 25 changed files with 766 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
@@ -0,0 +1,7 @@
*.pyc
env
*.txt
bashplotlib.egg-info
build
dist

7 changes: 7 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,7 @@
Copyright (c) 2013 Greg Lamp

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
5 changes: 5 additions & 0 deletions MANIFEST
@@ -0,0 +1,5 @@
# file GENERATED by distutils, do NOT edit
setup.py
bashplotlib/__init__.py
bashplotlib/histogram.py
bashplotlib/scatterplot.py
74 changes: 74 additions & 0 deletions README.md
@@ -0,0 +1,74 @@
# bashplotlib
*plotting in the terminal*

<img src="examples/img/basichist.png">

## what is it?
bashplotlib is a python package and command line tool for making basic plots in the terminal. It's a quick way to visualize data when you don't have a GUI. It's written in pure python and can quickly be installed anywhere using pip.

## installation
### install with pip
```
$ pip install bashplotlib
```
### install from source
```
$ git clone git@github.com:glamp/bashplotlib.git
$ cd bashplotlib
$ python setup.py install
```

Either method will install the bashplotlib python package and will also add <code>hist</code> and <code>scatter</code>
to your python scripts folder. This folder should be on your path (add it if it's not).

## features

- quick plotting from the command line
- customize the color, size, title, and shape of plots
- pipe data into plots with stdin


## usage
### command line
<code>hist</code> takes input from either stdin or specified using the -f parameter. Input should be a single column of numbers.
<img src="examples/img/histhelp.png">
<code>scatter</code> takes x and y coordinates as input form either a comma delimited file using -f or from 2 different files using -x and -y.
<img src="examples/img/scatterhelp.png">

### in python
If you want to use bashplotlib from python, just import histogram and scatterplot.
```
from bashplotlib.scatterplot import plot_scatter
```
<img src="examples/img/scatterplothelp.png">

```
from bashplotlib.histogram import plot_hist
```

<img src="examples/img/histogramhelp.png">

## examples
```
$ scatter --file data/texas.txt --pch .
```
<img src="examples/img/texas.png">

```
$ hist --file data/exp.txt
```
<img src="examples/img/histogram.png">

```
$ scatter -x data/x_test.txt -y data/y_test.txt
```
<img src="examples/img/scatter.png">

## todo

- sideways numbers for x-axis of histograms
- colors for individual points
- line charts
- trendlines


91 changes: 91 additions & 0 deletions README.rst
@@ -0,0 +1,91 @@
bashplotlib
===========

*plotting in the terminal*

what is it?
-----------

bashplotlib is a python package and command line tool for making basic
plots in the terminal. It's a quick way to visualize data when you don't
have a GUI. It's written in pure python and can quickly be installed
anywhere using pip.

installation
------------

install with pip
~~~~~~~~~~~~~~~~

::

$ pip install bashplotlib

install from source
~~~~~~~~~~~~~~~~~~~

::

$ git clone git@github.com:glamp/bashplotlib.git
$ cd bashplotlib
$ python setup.py install

Either method will install the bashplotlib python package and will also
add hist and scatter to your python scripts folder. This folder should
be on your path (add it if it's not).

features
--------

- quick plotting from the command line
- customize the color, size, title, and shape of plots
- pipe data into plots with stdin

usage
-----

command line
~~~~~~~~~~~~

hist takes input from either stdin or specified using the -f parameter.
Input should be a single column of numbers. scatter takes x and y
coordinates as input form either a comma delimited file using -f or from
2 different files using -x and -y.

in python
~~~~~~~~~

If you want to use bashplotlib from python, just import histogram and
scatterplot.

::

from bashplotlib.scatterplot import plot_scatter

::

from bashplotlib.histogram import plot_hist

examples
--------

::

$ scatter --file data/texas.txt --pch .

::

$ hist --file data/exp.txt

::

$ scatter -x data/x_test.txt -y data/y_test.txt

todo
----

- sideways numbers for x-axis of histograms
- colors for individual points
- line charts
- trendlines

Empty file added bashplotlib/__init__.py
Empty file.

0 comments on commit 956d0f3

Please sign in to comment.