| Name | pyC8 JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | https://www.macrometa.com |
| Summary | Python SDK for Macrometa Global Data Mesh |
| upload_time | 2024-03-25 07:44:00 |
| maintainer | None |
| docs_url | None |
| author | Macrometa |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyC8 SDK
Python SDK for the Macrometa Global Data Mesh.
---
## 🐍 Supported Python Versions
This SDK supports the following Python implementations:
* Python 3.4 - 3.10
## ⚙️ Installation
Install from PyPi using [pip](https://pip.pypa.io/en/latest/), a
package manager for Python.
```commandline
pip install pyC8
```
## 🔐 Authentication
Currently, pyC8 supports API Key, JWT token, username and password authentication.
Preferred method needs to be passed during client creation. We highly recommend that you use API key or JWT token.
You can create you test Macrometa account with this [link](https://auth-play.macrometa.io/sign-up).
After that you can check out our [getting started code examples](https://github.com/Macrometacorp/pyC8/blob/master/GETTING_STARTED.md).
## 🧰 Development environment
To enable development environment position ourselves to project's root and run:
```bash
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>"`
* `API_KEY="<your api key>"`
`.env` file is in `.gitignore`.
To run tests position yourself in the project's root while your virtual environment
is active and run:
```bash
python -m pytest
```
Since we have end-to-end test we use VCR package to record our response so tests can be faster in next iteration.
Example:
```bash
pytest --record-mode=once test_redis.py
```
Cassettes folder will be created with '.yaml'. Each test will have its own file.
## 📐 Enable pre-commit hooks
You will need to install pre-commit hooks
Using homebrew:
```bash
brew install pre-commit
```
Using conda (via conda-forge):
```bash
conda install -c conda-forge pre-commit
```
To check installation run:
```bash
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:
```bash
pre-commit install
```
Run against all files:
```bash
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:
```bash
$ python setup.py build
```
## 🪛 Upgrade
```bash
pip install --upgrade pyC8
```
## 📗 Examples
You can find code examples in our [getting started collection](https://github.com/Macrometacorp/pyC8/blob/master/GETTING_STARTED.md).
## 🆘 Macrometa Support
If you have any trouble or need help while using SDK please contact [support@macrometa.com](mailto:support@macrometa.com).
## ⚖️ License
This library is distributed under the Apache License 2.0 license found in the [License](https://github.com/Macrometacorp/pyC8/blob/master/LICENSE).
## 📜 Code of Conduct
This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/Macrometacorp/pyC8/blob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [product@macrometa.com](mailto:product@macrometa.com).
Raw data
{
"_id": null,
"home_page": "https://www.macrometa.com",
"name": "pyC8",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Macrometa",
"author_email": "product@macrometa.com",
"download_url": "https://files.pythonhosted.org/packages/38/6b/fff35fcd3ef42dacca8593205754c4465183e31f32fdef7d486891b60d8f/pyC8-1.1.2.tar.gz",
"platform": null,
"description": "# PyC8 SDK\n\n\n\n\n\n\n\nPython SDK for the Macrometa Global Data Mesh.\n\n---\n\n## \ud83d\udc0d Supported Python Versions\n\nThis SDK supports the following Python implementations:\n\n* Python 3.4 - 3.10\n\n## \u2699\ufe0f Installation\n\nInstall from PyPi using [pip](https://pip.pypa.io/en/latest/), a\npackage manager for Python.\n\n```commandline\npip install pyC8\n```\n\n## \ud83d\udd10 Authentication\n\nCurrently, pyC8 supports API Key, JWT token, username and password authentication.\nPreferred method needs to be passed during client creation. We highly recommend that you use API key or JWT token.\n\nYou can create you test Macrometa account with this [link](https://auth-play.macrometa.io/sign-up).\n\nAfter that you can check out our [getting started code examples](https://github.com/Macrometacorp/pyC8/blob/master/GETTING_STARTED.md).\n\n## \ud83e\uddf0 Development environment\n\nTo enable development environment position ourselves to project's root and run:\n\n```bash\npip install -r requirements/dev.txt\n```\n\n## \ud83e\uddea Testing\n\nEnd-to-end tests can be found in tests/.\nBefore first run create .env file in tests/.\nIn `.env` file add variables:\n\n* `FEDERATION_URL=\"<your federation url>\"`\n* `FABRIC=\"<selected fabric>\"`\n* `API_KEY=\"<your api key>\"`\n\n`.env` file is in `.gitignore`.\n\nTo run tests position yourself in the project's root while your virtual environment\nis active and run:\n```bash\npython -m pytest\n```\n\nSince we have end-to-end test we use VCR package to record our response so tests can be faster in next iteration.\nExample:\n```bash\npytest --record-mode=once test_redis.py\n```\nCassettes folder will be created with '.yaml'. Each test will have its own file.\n\n## \ud83d\udcd0 Enable pre-commit hooks\n\nYou will need to install pre-commit hooks\nUsing homebrew:\n```bash\nbrew install pre-commit\n```\nUsing conda (via conda-forge):\n```bash\nconda install -c conda-forge pre-commit\n```\nTo check installation run:\n```bash\npre-commit --version\n```\nIf installation was successful you will see version number.\nYou can find the Pre-commit configuration in `.pre-commit-config.yaml`.\nInstall the git hook scripts:\n```bash\npre-commit install\n```\nRun against all files:\n```bash\npre-commit run --all-files\n```\nIf setup was successful pre-commit will run on every commit.\nEvery time you clone a project that uses pre-commit, running `pre-commit install`\nshould be the first thing you do.\n\n## \ud83d\udc68\u200d\ud83d\udcbb Build\n\nTo build package we need to position ourselves to project's root and run:\n\n```bash\n $ python setup.py build\n```\n\n## \ud83e\ude9b Upgrade\n```bash\npip install --upgrade pyC8\n```\n\n## \ud83d\udcd7 Examples\nYou can find code examples in our [getting started collection](https://github.com/Macrometacorp/pyC8/blob/master/GETTING_STARTED.md).\n\n## \ud83c\udd98 Macrometa Support\n\nIf you have any trouble or need help while using SDK please contact [support@macrometa.com](mailto:support@macrometa.com).\n\n## \u2696\ufe0f License\n\nThis library is distributed under the Apache License 2.0 license found in the [License](https://github.com/Macrometacorp/pyC8/blob/master/LICENSE).\n\n## \ud83d\udcdc Code of Conduct\n\nThis project and everyone participating in it is governed by the [Code of Conduct](https://github.com/Macrometacorp/pyC8/blob/master/CODE_OF_CONDUCT.md).\nBy participating, you are expected to uphold this code. Please report unacceptable behavior to [product@macrometa.com](mailto:product@macrometa.com).\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for Macrometa Global Data Mesh",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://www.macrometa.com"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a963e09549e0cb0a741d44eb7d970e4ce24cfd81af13eb8ff7e8d5d546657a18",
"md5": "1c3385431c8b5801f764cf621c9eb55f",
"sha256": "93da1600513d8c367f105538fd6f2932f1a22ae5a17ddee35c1da38e69f7aa68"
},
"downloads": -1,
"filename": "pyC8-1.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c3385431c8b5801f764cf621c9eb55f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 108623,
"upload_time": "2024-03-25T07:43:57",
"upload_time_iso_8601": "2024-03-25T07:43:57.970750Z",
"url": "https://files.pythonhosted.org/packages/a9/63/e09549e0cb0a741d44eb7d970e4ce24cfd81af13eb8ff7e8d5d546657a18/pyC8-1.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "386bfff35fcd3ef42dacca8593205754c4465183e31f32fdef7d486891b60d8f",
"md5": "3a4eea9c7fe094626b303e43237b6ec3",
"sha256": "f6b130ff3e84fe17a26945bd6846b2ba2bd1c4fc312461f0bf855c7d5a975f9f"
},
"downloads": -1,
"filename": "pyC8-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "3a4eea9c7fe094626b303e43237b6ec3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 99001,
"upload_time": "2024-03-25T07:44:00",
"upload_time_iso_8601": "2024-03-25T07:44:00.219613Z",
"url": "https://files.pythonhosted.org/packages/38/6b/fff35fcd3ef42dacca8593205754c4465183e31f32fdef7d486891b60d8f/pyC8-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 07:44:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyc8"
}
