Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laysakura/shellstreaming

A stream processor working with shell commands
https://github.com/laysakura/shellstreaming

Last synced: 17 days ago
JSON representation

A stream processor working with shell commands

Awesome Lists containing this project

README

        

shellstreaming
==============

.. image:: https://travis-ci.org/laysakura/shellstreaming.png?branch=master
:target: https://travis-ci.org/laysakura/shellstreaming

A stream processor working with shell commands

.. contents:: :local:

Tutorial
--------

See http://packages.python.org/shellstreaming/tutorial.html

For developers
--------------

API reference
#############

Sphinx-powered documents are available on http://packages.python.org/shellstreaming

Building and uploading documents
################################

.. code-block:: bash

$ ./setup.py build_sphinx
$ browser doc/html/index.html
$ ./setup.py upload_sphinx

Testing
#######

.. code-block:: bash

$ ./setup.py nosetests
$ browser htmlcov/index.html # check coverage

Some tests depend too much on personal configuration;
one needs Twitter OAuth info and another needs access to remote machine via `ssh`.
To enable all of these tests, comment out the line starts with `ignore-files` in `setup.cfg`
and run `nosetests` again.

Uploading packages to PyPI
##########################

.. code-block:: bash

$ emacs setup.py # edit `version` string
$ emacs CHANGES.txt
$ ./setup.py sdist upload

Or use `zest.releaser `_, a convenient tool for repeated release cycles.

Thanks
------

- `modocache `_ for a few pull requests!