starfish-py
Table of Contents
- About
- Features
- Prerequisites
- Quickstart
- Environment variables
- Testing
- New Version
- Mailing Lists
- Maintainers
- License
About
Starfish is an open-sourced developer toolkit for the data economy. Available in flavours of Java, Python, and Clojure, it allows developers, data scientists and enterprises to create, interact, integrate and manage a data supply line through standardised and simple-to-use APIs.
Based on an underlying data ecosystem standard, Starfish provides high-level APIs for common tasks within the data economy, for example, registering/publishing an asset, for subsequent use in a data supply line. In this case, an asset can be any data set, model or data service. The high-level API also allows developers to invoke operation on an asset, e.g. computing a predictive model or anonymising sensitive personal information, among other capabilities.
Starfish works with blockchain networks, such as Ocean Protocol, and common web services through agents, allowing unprecedented flexibility in asset discovery and data supply line management.
Starfish-py provides user access and tools to work with the Ocean Protocol Network, delegating certain functions via the python library squid-py.
While we strive to deliver code at a high quality, please note, that there exist parts of the library that still need thorough testing. Contributions – whether it is in the form of new features, better documentation or tests – are welcome.
Prerequisites
Python >= 3.6
Development
-
Clone this repo
clone https://github.com/datacraft-dsc/starfish-py.git cd starfish-py
-
Set up a virtual environment
virtualenv venv source venv/bin/activate
-
Install package requirements for starfish
make install -
Run the unit tests, without any supporting software/libraries outside of starfish
make test_unit -
Create the local testing environment using datacraft-chain.
In a seperate terminal session you need to clone and checkout
datacraft-chainrepository, by doing the following:git clone https://github.com/datacraft-dsc/datacraft-chain.git cd datacraft-chain ./start_datacraft_chain.sh test -
Run the integration tests
pytest tests/integration -
Run the all tests
make tests
Documentation
-
Build Sphinx documentation
To build the Syphinx auto documentation, you need to do the following:
make docs
The documentation for this repo.
Testing
Automatic tests are setup via github actions. Our test use pytest framework. The testing uses a datacraft-chain docker image and surfer server. See github actions for testing
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.
Mailing Lists
- starfish-qa -- General questions regarding the usage of Starfish.
Release Process
See Release Process
Maintainers
License
Copyright 2018-2021 Datacraft 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.
1 maintainer
Metadata
1 maintainer
Release files for starfish-py 0.17.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| starfish-py-0.17.16.tar.gz | 60.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| starfish_py-0.17.16-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 143.5 kB
Release files / starfish-py-0.17.16.tar.gz
| Download URL | starfish-py-0.17.16.tar.gz |
|---|---|
| Size | 60.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
477f08f0beb129d31aec813b3e6bbeebd92e5c31864b8076bcf1470dc2efd997
|
|
BLAKE2b-256 checksum How to use checksums |
53753c594ea21f3d00888a9088db8538b1c59fb1d01ad11837defe6c613580fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / starfish_py-0.17.16-py2.py3-none-any.whl
| Download URL | starfish_py-0.17.16-py2.py3-none-any.whl |
|---|---|
| Size | 83.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
2083cc88298aeeae65eac0ef6210c959ea70c877cb46db01178c172a3141dcd4
|
|
BLAKE2b-256 checksum How to use checksums |
4da989b078a9680cc63d99041eb57330b1e787673a41f3424b844fcaf60b2109
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
