Metadata-Version: 2.1
Name: pyshuttle
Version: 0.3.0.dev1
Summary: Cross-chain atomic swaps between the networks of two cryptocurrencies.
Home-page: https://github.com/meherett/shuttle
Author: Meheret Tesfaye
Author-email: meherett@zoho.com
License: AGPL-3.0
Keywords: cross-chain,atomic-swap,cryptocurrencies
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Requires-Python: >=3.6,<4
Description-Content-Type: text/markdown
Requires-Dist: requests (<3,>=2.22.0)
Requires-Dist: cryptos (<2,>=1.36)
Requires-Dist: chainside-btcpy (<1,>=0.6.5)
Requires-Dist: mnemonic (<1,>=0.19)
Requires-Dist: py-equity (<1,>=0.1.0)
Requires-Dist: click (<8,>=7.1.2)
Requires-Dist: pybytom (<2,>=1.3.0)
Requires-Dist: six (<2,>=1.15.0)
Provides-Extra: docs
Requires-Dist: sphinx (<3,>=2.4.4) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (<1,>=0.4.3) ; extra == 'docs'
Requires-Dist: sphinx-click (<3,>=2.3.1) ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (<6,>=5.4.1) ; extra == 'tests'
Requires-Dist: pytest-cov (<3,>=2.8.1) ; extra == 'tests'

# Shuttle

[![Build Status](https://travis-ci.org/meherett/shuttle.svg?branch=development)](https://travis-ci.org/meherett/shuttle?branch=development)
[![PyPI Version](https://img.shields.io/pypi/v/pyshuttle.svg?color=blue)](https://pypi.org/project/pyshuttle)
[![Documentation Status](https://readthedocs.org/projects/shuttle/badge/?version=development)](https://shuttle.readthedocs.io/en/latest/?badge=development)
[![Coverage Status](https://coveralls.io/repos/github/meherett/shuttle/badge.svg?branch=development)](https://coveralls.io/github/meherett/shuttle?branch=development)

Shuttle is a python library forÂ cross-chain atomic swaps betweenÂ the networksÂ ofÂ twoÂ cryptocurrencies. Cross-chain atomic swaps are the cheapest and most secure way to swapÂ cryptocurrencies. Itâ€™s a brand new decentralized payment environment based on Hash Time Lock Contracts (HTLCs) protocol. [Documentation](https://shuttle.readthedocs.io/en/development)

## Available Cryptocurrencies

Shuttle has the following available cryptocurrencies to swap:

| Cryptocurrencies                                        | Mainnet | Testnet | Solonet | 
| ------------------------------------------------------- | :-----: | :-----: | :-----: |
| [Bitcoin](https://github.com/bitcoin/bitcoin) `BTC`     | Yes     | Yes     | None    |
| [Bytom](https://github.com/bytom/bytom) `BTM`, `Assets` | Yes     | No      | No      |

## Dependencies

* [bytom-wallet-desktop](https://bytom.io/en/wallet/) - version [1.1.0](https://github.com/Bytom/bytom/releases/tag/v1.1.0) or greater.
* [pip](https://pypi.org/project/pip/) - To install packages from the Python Package Index and other indexes.
* [python3](https://www.python.org/downloads/release/python-368/) version 3.6 or greater.

## Installation

PIP to install shuttle globally. For Linux sudo may be required.

```
$ pip install pyshuttle
```

For the versions available, see the [tags on this repository](https://github.com/meherett/shuttle/tags).

## Development

We welcome pull requests. To get started, just fork this repo, clone it locally, and run:

```
$ pip install -e .[tests] -r requirements.txt
```

## Testing

Tests are still under development.

You can run the tests with:

```
$ pytest
```

Or use `tox` to run the complete suite against the full set of build targets, or pytest to run specific 
tests against a specific version of Python.

## Contributing

Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.

## License

Distributed under the [AGPL-3.0](https://github.com/meherett/shuttle/blob/master/LICENSE) license. See ``LICENSE`` for more information.


