Skip to content

Commit

Permalink
Documents updated for 0.4.1 release.
Browse files Browse the repository at this point in the history
Removed pcsm.py as it is not ready for new scope of the design.
  • Loading branch information
ywangd committed Mar 6, 2015
1 parent 5f55c2d commit 8315c9b
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 333 deletions.
31 changes: 31 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Change Log #

### Version 0.4.1 - 2015-03-06
* New Features
* StaSh now provides localized input history for running scripts.
* New `py_pdb` config option to enable dropping into pdb when a runing
script errors out. This makes it convenient to debug Python scripts
inside StaSh.
* Added ipython style (up-key) history search

* Improvements
* Started overhaul of the `git` command.
* It now takes a more modular approach to separate complex sub-command
into its own module.
* `branch`, `merge`, `reset`, `fetch` sub-commands significantly
improved.
* Updated dependancies on latest dulwich release.
* Press `CC` (Control-C) while script is waiting for user input no longer
breaks sub-sequent user input.
* Better docstring for scripts
* Various bug fixes

* Command Scripts
* New scripts
- `stashconf.py` - Change StaSh configuration on the fly
- `telnet.py` - Simple telnet client
* Changed scripts
- `pcsm.py` - Removed. The scope of the design has been broadened to
target all pythonista scripts. The script will be back when it is
ready for the design change (under a different name). In the mean
time, [psiclient](https://github.com/ywangd/psiclient) is a
proof-of-concept client for Pythonista Script Index.

### Version 0.4.0 - 2015-01-29
* New Features
* **New UI design with unified Input/Output areas**
Expand Down
38 changes: 17 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Since its initial release, valuable contributions and advices have been received
constantly from the Pythonista community (especially from
[@briarfox](https://github.com/briarfox),
[@dgelessus](https://github.com/dgelessus),
[@jsbain](https://github.com/jsbain), [@pudquick](https://github.com/pudquick)
and [@oefe](https://github.com/oefe)).
[@jsbain](https://github.com/jsbain), [@pudquick](https://github.com/pudquick),
[@oefe](https://github.com/oefe)) and [@cclauss](https://github.com/cclauss).

StaSh stands for Pythoni**sta** **Sh**ell. While **Sta** may not be the best
abbreviation for Pythonista, it forms a concise and meaningful word with the
Expand Down Expand Up @@ -134,25 +134,22 @@ features are what really set the difference from shellista.


## Installation
The code is hosted on GitHub (https://github.com/ywangd/stash).

A gist file is also provided as a single file installation
(https://gist.github.com/ywangd/7fbb2c1aa17e8734defd).

### Single File Installation with Gist
* Either use the [New from
Gist](https://gist.github.com/omz/b0644f5ed1d94bd32805) script or simply
copy/paste to get the gist file, `getstash.py`, at
https://gist.github.com/ywangd/7fbb2c1aa17e8734defd
* Run `getstash.py` to download and install StaSh.
* It by default installs to a folder named **stash** under your document
root, i.e. `~/Documents/stash`.

### Install from GitHub
If you have a GitHub tool available in Pythonista, such as
StaSh can be installed easily via a single line of python commands (courtesy of
@whitone). Simply copy and paste the following line into Pythonista interactive
prompt and run.

```Python
import urllib2; exec urllib2.urlopen('http://bit.ly/get-stash').read()
```

The above command installs StaSh to a folder named **stash** under your
document root, i.e. `~/Documents/stash`.

(If you have a GitHub tool available in Pythonista, such as
[gitview](http://omz-forums.appspot.com/pythonista/post/5810965861892096) or
[gitrepo](http://omz-forums.appspot.com/pythonista/post/5795611756462080),
simply clone or download the repository.
you can choose to directly clone or download the
[repository](https://github.com/ywangd/stash).)

## Usage
The usage of StaSh is in principle similar to Bash. A few things to note are:
Expand Down Expand Up @@ -207,8 +204,6 @@ The usage of StaSh is in principle similar to Bash. A few things to note are:
* `mv.py`
* `openin.py` - Show the **open in** dialog to open a file in external apps.
* `paste.py` - Paste from iOS clipboard
* `pcsm.py` - Client program for [Pythonista Command Script
Index](https://github.com/ywangd/Pythonista-Command-Script-Index)
* `pip.py` - Search, download, install, update and uninstall pure Python
packages from PyPI.
* `printenv.py` - List environment variables
Expand All @@ -227,6 +222,7 @@ The usage of StaSh is in principle similar to Bash. A few things to note are:
used for terminal emulation and gives the command the feel of a
full-fledged SSH client.
* `ssh-keygen.py` - Generate RSA/DSA SSH Keys.
* `stashconf.py` - Change StaSh configuration on the fly
* `tar.py` - Manipulate archive files
* `touch.py` - Update timestamp of the given file or create it if not exist
* `uniq.py`
Expand Down
Loading

0 comments on commit 8315c9b

Please sign in to comment.