Wallet for Bitcoin Cash and tokens. https://orbit.cash

Shawn Wilson 1ed412115f Revert "Change relative imports to absolute (Windows). Add network menu." 8 months ago
ag 1ed412115f Revert "Change relative imports to absolute (Windows). Add network menu." 8 months ago
api cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
doc 1254912965 saw_052017_1 - Incorporate work from pyproject... the Sphinx documentation setup, etc. 2 years ago
etc cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
.gitignore 1254912965 saw_052017_1 - Incorporate work from pyproject... the Sphinx documentation setup, etc. 2 years ago
CHANGELOG 1ed412115f Revert "Change relative imports to absolute (Windows). Add network menu." 8 months ago
LICENSE cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
Makefile cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
README.rst f032d0ec0d BCH balance and receive are functional. 9 months ago
TODO cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
orbit-gui cbdb4d9320 Initial commit for orbit-gui (nothing yet). 9 months ago
setup.cfg dd3806011c saw_042017_1 - First commit for fauxpython. 2 years ago
setup.py 0a9f4d4677 fix PIL dependency? 8 months ago

README.rst

############################################################################
ORBIT GUI - Grahical User Interface for Op_Return Bitcoin-Implemented Tokens
############################################################################

.. image:: https://badges.gitter.im/AlphaGriffin/orbit.svg
:alt: Join the chat at https://gitter.im/AlphaGriffin/orbit
:target: https://gitter.im/AlphaGriffin/orbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

**A graphical user interface for interacting with tokens on Bitcoin Cash implementing the ORBIT standard.**

The official website for ORBIT is http://orbit.cash.

.. contents:: Table of Contents
:depth: 2
:local:


************
Introduction
************

The ORBIT GUI is a program that allows interaction with and management of tokens on Bitcoin Cash implementing the ORBIT standard.

ORBIT GUI is open source and licensed under the MIT license. See the `LICENSE `_ file for more details.


The ORBIT Ecosystem
===================

ORBIT is a specification for simple, fungible tokens implemented by utilizing OP_RETURN for the storage of token events on the Bitcoin Cash blockchain. No changes to the Bitcoin Cash protocol or nodes are required. However, wallets may wish to incorporate this token standard in order to allow the user to easily take account of and interact with tokens that adhere to this ORBIT standard.

The following projects, when used in conjunction with ORBIT GUI, complete a full ecosystem for tokens on Bitcoin Cash using ORBIT:

- ORBIT Specification and API: https://github.com/AlphaGriffin/orbit
- ORBIT Node: https://github.com/AlphaGriffin/orbit-node
- ORBIT Command-Line Interface: https://github.com/AlphaGriffin/orbit-cli
- ORBIT Web: https://github.com/AlphaGriffin/orbit-web


*************
Specification
*************

The ORBIT repository at https://github.com/AlphaGriffin/orbit defines the official and complete specification for ORBIT.

*The current specification version is: 0 (beta testing). Version 0 is reserved and should be used for all testing.*



************
Contributing
************

Your help is appreciated! Alpha Griffin is a small team focused on developing new technology projects. If you have questions or comments or would like to contribute to the ORBIT node or ecosystem in any way, please feel free to contact us. You may submit issues or pull requests directly on GitHub or communicate with the team members at the following locations:

- https://gitter.im/AlphaGriffin
- https://alphagriffintrade.slack.com

Have a suggestion or request? Let us know!


To-Do List
==========

There are a number of tasks already identified on the `To-Do list `_ that could use your help (included here in generated documentation).

.. include:: TODO
:literal:



*********
ORBIT GUI
*********

This ORBIT GUI is written in Python.


Dependencies
============

- Python 3
- ORBIT API: https://github.com/AlphaGriffin/orbit (``pip install git+https://github.com/AlphaGriffin/orbit``)
- appdirs: https://github.com/ActiveState/appdirs (``pip install appdirs``)
- BitCash >= 0.5.2.4: https://github.com/sporestack/bitcash (``pip install bitcash\>=0.5.2.4``)
- PyCrypto: https://github.com/dlitz/pycrypto (``pip install pycrypto``)
- qrcode: https://pypi.org/project/qrcode (``pip install qrcode``)
- PIL
- Qt5
- *For building documentation (optional):* sphinx and sphinx_rtd_theme (``pip install sphinx sphinx_rtd_theme``)

In addition to the above, ORBIT GUI requires RPC access to a local or remote ORBIT node for most operations, such as the one provided by Alpha Griffin (http://orbit.alphagriffin.com).


Build Overview
==============

Both a Makefile and setup.py are provided and used. The setup.py uses Python's standard setuptools package and you can call this script directly to do the basic Python tasks such as creating a wheel, etc.

The most common project build tasks are all provided in the Makefile. To see the full list of project targets::

make help

Sphinx is used to generate html documentation and man pages. All documentation (html as well as man pages) may be regenerated at any time with::

make docs

Every so often, when new source class files are created or moved, you will want to regenerate the API documentation templates. These templates may be modified by hand so this task does not overwrite existing files; you'll need to remove any existing files from ``api/`` that you want recreated. Then generate the API templates and re-build all documentation as follows::

make apidoc
make docs

There's not much to do for a simple Python project but your build may want to do more. In any case you can call ``make python`` if you need to (in orbit this target simply delegates to ``./setup.py build``).

Build all the common tasks (including documentation) as follows::

make all

To clean up all the common generated files from your project folder::

make clean


Installing
==========

To install this project to the local system::

make install

Note that you may need superuser permissions to perform the above step.


Using
=====

**FIXME**


**********
Python API
**********

.. toctree::
API Documentation


*******
History
*******

All changes are tracked in the `CHANGELOG `_ file.

.. include:: CHANGELOG
:literal:


----

*"Orbit the moon"*