Skip to content

Commit

Permalink
readme update and verbose=0
Browse files Browse the repository at this point in the history
  • Loading branch information
ziberna committed Feb 8, 2012
1 parent 2b72a1a commit ba30317
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 10 deletions.
39 changes: 30 additions & 9 deletions README.md
@@ -1,22 +1,16 @@
_Inspector_ is a re-implementation of Andrew Moffat's
[Inspect-Shell](https://github.com/amoffat/Inspect-Shell). At the moment it
doesn't support saving shell history to a file or auto-completion. The
additional features are:
doesn't support saving shell history to a file or auto-completion

- setting host, timeout and message passphrase. Port can also be set, but this
can already be done in the official implementation.
- server side notifications about client connections

It runs in both Python 2 and 3. Since the server (inspector importer) and the
client (inspector shell) are both separate processes, you can even run one side
It runs with both Python 2 and 3. Since the server (inspector importer) and the
client (inspector shell) are separate processes, you can even run one side
in Python 3 and the other in Python 2. Everything you type into the shell will
be evaluated with server's Python version though.


Example
-------


### Importer's side

The file that imports inspector will run a server. Importing the inspector
Expand Down Expand Up @@ -60,6 +54,33 @@ from anywhere.
>>> limit = 4096


Options
-------

- `inspector.VERBOSE` level of status updates
- `inspector.HOST`
- `inspector.PORT`
- `inspector.TIMEOUT_SERVER`
- `inspector.TIMEOUT_CLIENT`
- `inspector.PASSPHRASE` to ensure nobody is messing with your variables' values
- `inspector.CHUNK_SIZE` of each message chunk that is recieved


Command-line arguments
----------------------

usage: inspector.py [-h] [-l host] [-p port] [-t timeout] [-s passphrase]

Inspector

optional arguments:
-h, --help show this help message and exit
-l host
-p port
-t timeout
-s passphrase


Authors
-------

Expand Down
2 changes: 1 addition & 1 deletion inspector.py
Expand Up @@ -84,7 +84,7 @@
STATUS_STOPPED = '# Inspector stopped running'
STATUS_SHUTDOWN = '# Inspector server has shutdown'

VERBOSE = 1
VERBOSE = 0

def status(string, verbose=1):
"""
Expand Down

0 comments on commit ba30317

Please sign in to comment.