PyC8 SDK

Python SDK for the Macrometa Global Data Network.

---

🐍 Supported Python Versions

This SDK supports the following Python implementations:

• Python 3.4 - 3.10

⚙️ Installation

Install from PyPi using pip, a package manager for Python.

pip install pyC8

After that you can check out our getting started code examples.

🧶 Development environment

To enable development environment position ourselves to project's root and run:

pip install -r requirements/dev.txt

🧪 Testing

End-to-end tests can be found in tests/. Before first run create .env file in tests/. In .env file add variables:

• FEDERATION_URL="<your federation url>"
• FABRIC="<selected fabric>"
• TENANT_EMAIL="<your tenant email>"
• TENANT_PASSWORD="<your tenant password>"
• API_KEY="<your api key>"
• TOKEN="<your token>"
• MM_TENANT_EMAIL="<Macrometa tenant email>"
• MM_TENANT_PASSWORD="<Macrometa tenant password>"
• MM_API_KEY="<Macrometa apy key>"

Note: MM_TENANT_EMAIL, MM_TENANT_PASSWORD, MM_API_KEY are super user credentials

.env file is in .gitignore.

To run tests position yourself in the project's root while your virtual environment is active and run:

python -m pytest

📐 Enable pre-commit hooks

You will need to install pre-commit hooks Using homebrew:

brew install pre-commit

Using conda (via conda-forge):

conda install -c conda-forge pre-commit

To check installation run:

pre-commit --version

If installation was successful you will see version number. You can find the Pre-commit configuration in .pre-commit-config.yaml. Install the git hook scripts:

pre-commit install

Run against all files:

pre-commit run --all-files

If setup was successful pre-commit will run on every commit. Every time you clone a project that uses pre-commit, running pre-commit install should be the first thing you do.

👨‍💻 Build

To build package we need to position ourselves to project's root and run:

 $ python setup.py build

🪛 Upgrade

pip install --upgrade pyC8

📗 Examples

You can find code examples in our getting started collection.

📜 Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@macrometa.com.