Metadata-Version: 2.1
Name: starfish-py
Version: 0.4.9
Summary: Ocean/squid-py wrapper.
Home-page: https://github.com/DEX-Company/starfish-py
Author: dex-company
Author-email: devops@dex.sg
License: Apache Software License 2.0
Description: [![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://dex.sg)
        
        # starfish-py
        
        Floating on the surface of the Ocean. Ocean-py (Ocean Python) provides user access and tools to the Ocean Protocol Network, via the python library squid-py.
        
        [![Travis (.com)](https://img.shields.io/travis/com/DEX-Company/starfish-py.svg)](https://travis-ci.com/DEX-Company/starfish-py)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/385d72f0a6314b18bedd96e808a90e46)](https://www.codacy.com/app/billbsing/starfish-py?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DEX-Company/starfish-py&amp;utm_campaign=Badge_Grade)
        [![GitHub contributors](https://img.shields.io/github/contributors/DEX-Company/starfish-py.svg)](https://github.com/DEX-Company/starfish-py/graphs/contributors)
        [![Squid Version](https://img.shields.io/badge/squid--py-v0.6.15-blue.svg)](https://github.com/oceanprotocol/squid-py/releases/tag/v0.6.15)
        [![Barge Version](https://img.shields.io/badge/barge-dex--2019--08--08-blue.svg)](https://github.com/DEX-Company/barge/releases/tag/dex-2019-08-08)
        
        ---
        
        ## Table of Contents
        
          - [Features](#features)
          - [Prerequisites](#prerequisites)
          - [Quickstart](#quickstart)
          - [Environment variables](#environment-variables)
          - [Code style](#code-style)
          - [Testing](#testing)
          - [New Version](#new-version)
          - [License](#license)
        
        ---
        
        ## Features
        
        Currently only provide basic account balance information
        
        ## Prerequisites
        
        Python 3.6
        
        ## Development
        
        1. Clone this repo
        
            ```bash
            clone https://github.com/DEX-Company/starfish-py.git
            cd starfish-py
            ```
        
        1. Set up a virtual environment
        
            ```bash
            virtualenv venv
            source venv/bin/activate
            ```
        
        1. Install package requirements for starfish
        
            ```bash
            pip install -r requirements_dev.txt
            ```
        
        1. Run the unit tests, without any supporting software/libraries outside of starfish
        
            ```bash
            pytest tests/unit
            ```
        
        1. To run the full test using the current remote implementation of [barge](https://github.com/DEX-Company/barge).
        
           ```bash
           export BARGE_URL=http://52.187.164.74
           scripts/setup_for_remote_barge.sh $BARGE_URL
           ```
        
        1. Or to run barge locally on the same machine.
        
           ```bash
           export BARGE_URL=http://localhost
           scripts/setup_for_local_barge.sh
           ```
        
        1. Run the integration tests
        
            ```
            pytest tests/integration
            ```
        
        1. Run the all tests
        
            ```bash
            pytest tests
            ```
        
        ## Documentation
        
        1. Build Sphinx documentation
            To build the Syphinx auto documentation, you need to do the following:
            ```bash
            make docs
            ```
        
        The [documentation](https://shrimp.octet.services/starfish) for this repo is on the starfish doc site [shrimp server](https://shrimp.octet.services).
        
        ## Code style
        
        The information about code style in python is documented in this two links [python-developer-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-developer-guide.md)
        and [python-style-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-style-guide.md).
        
        ## Testing
        
        Automatic tests are setup via Travis, executing `tox`.
        Our test use pytest framework. The testing uses the remote barge server to test with
        
        ## New Version
        
        The `bumpversion.sh` script helps to bump the project version. You can execute the script using as first argument {major|minor|patch} to bump accordingly the version.
        
        ## License
        
        ```
        Copyright 2018 Ocean Protocol Foundation Ltd.
        Copyright 2018-2019 DEX Pte. Ltd.
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
           http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Keywords: starfish-py
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
