Skip to content

Commit

Permalink
Move to markdown for README (#3)
Browse files Browse the repository at this point in the history
* Move to markdown for README

* Add changelog
  • Loading branch information
yashmehrotra committed Jun 25, 2020
1 parent b706216 commit 317826f
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 47 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## v0.2.0

- Support for cwd when executing commands
- Supoort for streaming of output to stdout

## v0.1.0

Initial Relase
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Soldier: Subprocess with Style

[![image](https://img.shields.io/travis/yashmehrotra/soldier.svg?style=flat-square)](https://travis-ci.org/yashmehrotra/soldier) [![image](https://img.shields.io/badge/license-APACHE2-blue.svg?style=flat-square)](https://github.com/yashmehrotra/soldier/blob/master/LICENSE) [![Documentation](https://readthedocs.org/projects/soldier/badge/?version=latest)](http://soldier.readthedocs.org/en/latest/?badge=latest)

![image](https://raw.githubusercontent.com/yashmehrotra/soldier/master/images/flint.jpg)

Soldier is an Apache2 licensed library designed for executing and
managing system processes with ease.

It is written on top of subprocess and has a much user-friendly and
pythonic interface.

And the best part - it is very easy to get started

## Installation

``` sh
$ pip install soldier
```

## Getting Started

``` python
>>> import soldier

>>> print soldier.run('pwd').output
/home/python/

>>> firefox_process = soldier.run('firefox', background=True)
>>> firefox_process.pid
20749

>>> job = soldier.run('myjob', timeout=30)
```

## Documentation

The documentation is available at [soldier.readthedocs.io](http://soldier.readthedocs.io/)
46 changes: 0 additions & 46 deletions README.rst

This file was deleted.

3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
url='https://pypi.python.org/pypi/soldier',
license='Apache 2.0',
description='Subprocess with Style',
long_description=open('README.rst').read(),
long_description=open('README.md').read(),
long_description_content_type="text/markdown",
)

0 comments on commit 317826f

Please sign in to comment.