Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shekhar-shubhendu/squid-py
🦑 Python client library for Ocean Protocol
https://github.com/shekhar-shubhendu/squid-py
Last synced: about 1 month ago
JSON representation
🦑 Python client library for Ocean Protocol
- Host: GitHub
- URL: https://github.com/shekhar-shubhendu/squid-py
- Owner: shekhar-shubhendu
- License: apache-2.0
- Created: 2018-12-06T10:54:48.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2018-12-06T09:16:55.000Z (about 6 years ago)
- Last Synced: 2024-10-15T03:52:13.771Z (3 months ago)
- Language: Python
- Homepage:
- Size: 3.29 MB
- Stars: 1
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://oceanprotocol.com)
# squid-py
> 💧 Python wrapper, allowing to integrate the basic Ocean/web3.py capabilities
> [oceanprotocol.com](https://oceanprotocol.com)
[](https://travis-ci.com/oceanprotocol/squid-py)
[](https://app.codacy.com/project/ocean-protocol/squid-py/dashboard)
[](https://pypi.org/project/squid-py/)
[](https://github.com/oceanprotocol/squid-py/graphs/contributors)
---
## Table of Contents
- [Features](#features)
- [Quick-start](#quick-start)
- [Configuration](#configuration)
- [Development](#development)
- [License](#license)
---
## Features
Squid-py include the methods to make easy the connection with contracts deployed in different networks.
This repository include also the methods to encrypt and decrypt information.
## Prerequisites
Python 3.6
## Quick-start
Install Squid:
```
pip install squid-py
```
The entry point into the Squid functionality is the Ocean class:
```python
from squid_py.ocean import Ocean
ocean = Ocean('config.ini')
assert ocean.get_accounts()
```
## Configuration
`keeper.url` points to an Ethereum RPC client. Note that Squid learns the name of the network to work with from this client.
`keeper.path` points to the folder with keeper contracts definitions. When you install the package, the artifacts are
automatically picked up from the `keeper-contracts` Python dependency.
`storage.path` points to the local database file used for storing temporary information (for instance, pending service agreements).
In addition to the configuration file, you may use the following environment variables (override the corresponding configuration file values):
- KEEPER_PATH
- KEEPER_URL
- GAS_LIMIT
- AQUARIUS_URL
## Development
1. Set up a virtual environment
1. Install requirements
```
pip install -r requirements_dev.txt
```
1. Run Docker images. Alternatively, set up and run some or all of the corresponding services locally.
```
docker-compose -f ./docker/docker-compose.yml up
```
It runs an Aquarius node and an Ethereum RPC client. For details, read `docker-compose.yml`.
1. Create local configuration file
```
cp config.ini config_local.ini
```
`config_local.ini` is used by unit tests.
1. Copy keeper artifacts
A bash script is available to copy keeper artifacts into this file directly from a running docker image. This script needs to run in the root of the project.
The script waits until the keeper contracts are deployed, and then copies the artifacts.
```
./scripts/wait_for_migration_and_extract_keeper_artifacts.sh
```
The artifacts contain the addresses of all the deployed contracts and their ABI definitions required to interact with them.
1. Run the unit tests
```
python3 setup.py test
```
#### 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.
#### New Version / New Release
See [RELEASE_PROCESS.md](RELEASE_PROCESS.md)
## License
```
Copyright 2018 Ocean Protocol Foundation 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.