



  

Warp Pipe 0.1.0 documentation

[![Logo](_static/pylibrary.png)](index.html#document-index)

 latest

 

* [Installation](index.html#document-installation)

	+ [Stable release](index.html#stable-release)

	+ [From sources](index.html#from-sources)

* [Usage](index.html#document-usage)

* [Contributing](index.html#document-contributing)

	+ [Types of Contributions](index.html#types-of-contributions)

	+ [Get Started!](index.html#get-started)

	+ [Pull Request Guidelines](index.html#pull-request-guidelines)

	+ [Tips](index.html#tips)

* [Credits](index.html#document-authors)

	+ [Development Lead](index.html#development-lead)

	+ [Contributors](index.html#contributors)

* [History](index.html#document-history)

	+ [0.1.0 (2019-05-17)](index.html#id1)

[Warp Pipe](index.html#document-index)

* [Docs](index.html#document-index) »

* Warp Pipe 0.1.0 documentation

* [Edit on GitHub](https://github.com/yngtodd/pipe/blob/master/docs/index.rst)

---

Warp Pipe Documentation[¶](#warp-pipe-documentation "Permalink to this headline")

=================================================================================

Installation[¶](#installation "Permalink to this headline")

-----------------------------------------------------------

### Stable release[¶](#stable-release "Permalink to this headline")

To install pipe, run this command in your terminal:

```

pip install pipe

```

This is the preferred method to install pipe, as it will always install the most recent stable release.

If you don’t have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide

you through the process.

### From sources[¶](#from-sources "Permalink to this headline")

The sources for pipe can be downloaded from the [Github repo](https://github.com/yngtodd/pipe).

You can either clone the public repository:

```

git clone git://github.com/yngtodd/pipe

```

Or download the [tarball](https://github.com/yngtodd/pipe/tarball/master):

```

curl -OL https://github.com/yngtodd/pipe/tarball/master

```

Once you have a copy of the source, you can install it with:

```

python setup.py install

```

Usage[¶](#usage "Permalink to this headline")

---------------------------------------------

To use Warp Pipe in a project:

```

import pipe

```

Contributing[¶](#contributing "Permalink to this headline")

-----------------------------------------------------------

Contributions are welcome, and they are greatly appreciated! Every

little bit helps, and credit will always be given.

You can contribute in many ways:

### Types of Contributions[¶](#types-of-contributions "Permalink to this headline")

#### Report Bugs[¶](#report-bugs "Permalink to this headline")

Report bugs at <https://github.com/yngtodd/pipe/issues>.

If you are reporting a bug, please include:

* Your operating system name and version.

* Any details about your local setup that might be helpful in troubleshooting.

* Detailed steps to reproduce the bug.

#### Fix Bugs[¶](#fix-bugs "Permalink to this headline")

Look through the GitHub issues for bugs. Anything tagged with “bug”

is open to whoever wants to implement it.

#### Implement Features[¶](#implement-features "Permalink to this headline")

Look through the GitHub issues for features. Anything tagged with “feature”

is open to whoever wants to implement it.

#### Write Documentation[¶](#write-documentation "Permalink to this headline")

Warp Pipe could always use more documentation, whether as part of the

official Warp Pipe docs, in docstrings, or even on the web in blog posts,

articles, and such.

#### Submit Feedback[¶](#submit-feedback "Permalink to this headline")

The best way to send feedback is to file an issue at <https://github.com/yngtodd/pipe/issues>.

If you are proposing a feature:

* Explain in detail how it would work.

* Keep the scope as narrow as possible, to make it easier to implement.

* Remember that this is a volunteer-driven project, and that contributions

are welcome :)

### Get Started![¶](#get-started "Permalink to this headline")

Ready to contribute? Here’s how to set up pipe for

local development.

1. [Fork](https://github.com/Nekroze/pipe/fork) the pipe repo on GitHub.

2. Clone your fork locally:

```

git clone git@github.com:your\_name\_here/pipe.git

```

3. Create a branch for local development:

```

git checkout -b name-of-your-bugfix-or-feature

```

Now you can make your changes locally.

4. When you’re done making changes, check that your changes pass style and unit

tests, including testing other Python versions with tox:

```

tox

```

To get tox, just pip install it.

5. Commit your changes and push your branch to GitHub:

```

git add .

git commit -m "Your detailed description of your changes."

git push origin name-of-your-bugfix-or-feature

```

6. Submit a pull request through the GitHub website.

### Pull Request Guidelines[¶](#pull-request-guidelines "Permalink to this headline")

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.

2. If the pull request adds functionality, the docs should be updated. Put

your new functionality into a function with a docstring, and add the

feature to the list in README.rst.

3. The pull request should work for Python >= 3.6 and for PyPy.

Check <https://travis-ci.org/yngtodd/pipe>

under pull requests for active pull requests or run the `tox` command and

make sure that the tests pass for all supported Python versions.

### Tips[¶](#tips "Permalink to this headline")

To run a subset of tests:

```

py.test test/test\_pipe.py

```

Credits[¶](#credits "Permalink to this headline")

-------------------------------------------------

### Development Lead[¶](#development-lead "Permalink to this headline")

* Todd Young GitHub: [yngtodd](https://github.com/yngtodd)

### Contributors[¶](#contributors "Permalink to this headline")

None yet. Why not be the first?

History[¶](#history "Permalink to this headline")

-------------------------------------------------

### 0.1.0 (2019-05-17)[¶](#id1 "Permalink to this headline")

* First release on PyPI.

Feedback[¶](#feedback "Permalink to this headline")

===================================================

If you have any suggestions or questions about **Warp Pipe** feel free to email me

at [ygx@ornl.gov](mailto:ygx%40ornl.gov).

If you encounter any errors or problems with **Warp Pipe**, please let me know!

Open an Issue at the GitHub <http://github.com/yngtodd/pipe> main repository.

