Metadata-Version: 2.1
Name: ocean-keeper
Version: 0.3.5
Summary: 🐳 Library including all the common functionalities used in Python projects
Home-page: https://github.com/oceanprotocol/keeper-py-lib
Author: leucothia
Author-email: devops@oceanprotocol.com
License: Apache Software License 2.0
Description: # ocean-keeper
        Wraps keeper contracts and web3 functions.
        
        ##### How to
        The main class is `Keeper` and all contracts are accessible directly from the `keeper` instance.
        Each deployed contract has a python wrapper class exposing the main functions and validating 
        inputs. It is possible to access the Web3 Contract functions directly by using the `contract_concise` 
        attribute of the wrapper instance.
        
        ```python
        import os
        from ocean_keeper import Keeper
        from ocean_keeper.contract_handler import ContractHandler
        from ocean_keeper.web3_provider import Web3Provider
        from ocean_keeper.utils import get_account
        
        # Init the web3 instance
        Web3Provider.init_web3('http://localhost:8545')  # Assume running with local parity node
        # set the contract handler path to abi files
        ContractHandler.set_artifacts_path(os.path.expanduser('~/.ocean/keeper-contracts/artifacts'))
        # get keeper instance
        keeper = Keeper.get_instance()
        # Do stuff with keeper and it's contracts
        account = get_account(0)
        keeper.did_registry.register('0x10101010101010101010', '', 'http://localhost:5000/api/v1/assets', account)
        
        ```
        
        Account can be specified using the following environment variables:
        * PARITY_ADDRESS: the ethereum address
        * PARITY_PASSWORD: the password to decrypt key in the `PARITY_ENCRYPTED_KEY` or `PARITY_KEYFILE`
        * PARITY_KEY: the private key of this account (matches the `PARITY_ADDRESS`), password is not required when this is specified
        * PARITY_ENCRYPTED_KEY: the encrypted key in a json str (same content of the `PARITY_KEYFILE`)
        * PARITY_KEYFILE: path to the json file that has the encrypted key specified in json document
        
        Note: The keys are loaded in this order: `PARITY_KEY`, `PARITY_ENCRYPTED_KEY`, `PARITY_KEYFILE`. If `PARITY_KEY` is 
        specified the password and other environment variables are ignored.
        
        For more details refer to the `keeper-contracts` repo at `https://github.com/oceanprotocol/keeper-contracts`
Keywords: ocean-keeper
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
Provides-Extra: docs
