Metadata-Version: 2.1
Name: shipchain-hydra
Version: 1.0.7
Summary: Hydra manages many heads of networks
Home-page: https://github.com/shipchain/hydra
Author: Lee Bailey
Author-email: lbailey@shipchain.io
License: Apache-2.0
Description: <p align="center">
          <img src="https://shipchain.io/img/logo.png" alt="ShipChain"/>
        </p>
        
        
        [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
        [![Chat](https://img.shields.io/badge/gitter-ShipChain/lobby-green.svg)](https://gitter.im/ShipChain/Lobby)
        
        # Hydra manages many heads of networks
        
        ## Quick-start Guide
        Just trying to use hydra? Follow our [Validator Setup Guide](https://docs.shipchain.io/docs/validatorGuide.html)
        
        # Developer Instructions
        
        ### Install
        ``` 
        make virtualenv
        source env/bin/activate
        ```
        ### Configure client and run node
        
        Note: Replace network-name with your chosen network (e.g. shipchain-testnet-alpha)
        1. Join a network
        `hydra client join-network -n network-name`
        2. Configure client
        `hydra client configure -n network-name`
        3. Start node and begin syncing with network - this will take a while
        `cd network-name && ./start_blockchain.sh`
        
        Your node is sync'd to the network when `curl localhost:46657/status` returns `sync_info.catching_up: false`
        
        Shipchain validator node commands can be accessed from `~/hydra/network-name/shipchain`
        
        
        ## General Installation and Development Guidelines
        
        ### Installation
        ```
        $ pip install -r requirements.txt
        
        $ pip install setup.py
        ```
        
        ### Development
        
        This project includes a number of helpers in the `Makefile` to streamline common development tasks.
        
        #### Environment Setup
        
        The following demonstrates setting up and working with a development environment:
        
        ```
        ### create a virtualenv for development
        
        $ make virtualenv
        
        $ source env/bin/activate
        
        
        ### run hydra cli application
        
        $ hydra --help
        
        
        ### run pytest / coverage
        
        $ make test
        ```
        
        
        #### Releasing to PyPi
        
        Before releasing to PyPi, you must configure your login credentials:
        
        **~/.pypirc**:
        
        ```
        [pypi]
        username = YOUR_USERNAME
        password = YOUR_PASSWORD
        ```
        
        Then use the included helper function via the `Makefile`:
        
        ```
        $ make dist
        
        $ make dist-upload
        ```
        
        ### Deployments
        
        #### Docker
        
        Included is a basic `Dockerfile` for building and distributing `ShipChain Network Hydra Manager`,
        and can be built with the included `make` helper:
        
        ```
        $ make docker
        
        $ docker run -it hydra --help
        ```
        
Keywords: blockchain,shipchain,loomnetwork,loom,hydra
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
