# Taxa Network Python SDK
Library used to aid developers in building applications on the Taxa Network.
It works with both Python 2.7 and Python 3.5+.
## Installation
1. Download the zip file from Github. Extract into a folder anywhere.
2. On the command line, navigate to that folder and run the install script: `python setup.py install`
3. To enable the SGX's remote attestation feature on your node, follow these instructions to generate a service provider ID (SPID) and primary key:
- Register with Intel [here](https://www.intel.com/content/www/us/en/forms/developer/standard-registration.html).
- Go to https://api.portal.trustedservices.intel.com/EPID-attestation
- In the Development access section, click the Subscribe (unlickable) button. Follow the steps to generate an SPID and Primary Key.
- Then run the following command, including your newly generated SPID and primary key:
```
python -m taxa_sdk.install_intel_keys [SPID] [primary key]
```
4. If you are on OSX, you need to install the Apple signed libraries:
```
sudo python -m taxa_sdk.install_osx_libs
```
(Note the requirement of sudo)
## Documentation
The documentation for this SDK can be found [here](https://docs.taxa.network/python-sdk).
## Running tests
To run the tests for this module, run the following commands:
### Testing through the WebUI
To test just the attestation process, using the WebUI:
```
python -m taxa_sdk.tests TestAttestationWebUI
```
To test the full millionaire test using the WebUI, run this command:
```
python -m taxa_sdk.tests TestMillionaireByIdentity
```
Note: If you want to limit your tests to just a WebUI running of a specific server,
then modify the `FORCEIP` variable at the top of `taxa_sdk/tests.py`. If `FORCEIP`
is set to `None` (The default), then the node distributer will pick a server
for you.
Also note that all tests ran though the WebUI will use the version of
`taxa_client` that comes bundled with the SDK.
### Running tests through the command line (bypassing WebUI)
To run the millionaire test via `taxa_server` via command line, bypassing the
WebUI, then use the following command:
```
python -m taxa_sdk.tests TestBypassWebUI
```
To just run the attestation via the `taxa_server` via command line, use this
command:
```
python -m taxa_sdk.tests TestBypassWebUI.test_attestation
```
Note: you must modify the tests.py file at the top to include the paths to the
command line `taxa_client` and `taxa_server` to do the `BypassWebUI` tests.
### Testing parameters
There are a few things you can change via the command line. These extra\
parameters must be placed *before* the name of the test classes.
#### --forceip
```
python -m taxa_sdk.tests --forceip=13.92.194.125 TestMillionaireByIdentity
```
This will force the test to run on the node at the passed in IP. If this option
is not used, the ip will be gotten from the P2P network.
#### --nop2p
This will force the IP to be gotten from the node distributor web service instead
of the P2P network.
#### --keepkeys
By default all tests delete their keys after finishing. With this option included,
the keys will not be deleted. This means you can run the tests over and over, and it
will skip attestation. hence speeding up the tests.
Raw data
{
"_id": null,
"home_page": "https://github.com/taxa-network/taxa-sdk-python",
"name": "taxa-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "TF Guo",
"author_email": "tf@taxa.network",
"download_url": "https://files.pythonhosted.org/packages/d5/bc/112d20ff206c4fa74d1ff36a1d3df37312322802a5d7a660d38f5f0b50e2/taxa-sdk-0.3.2.tar.gz",
"platform": null,
"description": "# Taxa Network Python SDK\n\nLibrary used to aid developers in building applications on the Taxa Network.\nIt works with both Python 2.7 and Python 3.5+.\n\n## Installation\n\n1. Download the zip file from Github. Extract into a folder anywhere.\n2. On the command line, navigate to that folder and run the install script: `python setup.py install`\n3. To enable the SGX's remote attestation feature on your node, follow these instructions to generate a service provider ID (SPID) and primary key:\n - Register with Intel [here](https://www.intel.com/content/www/us/en/forms/developer/standard-registration.html).\n - Go to https://api.portal.trustedservices.intel.com/EPID-attestation\n - In the Development access section, click the Subscribe (unlickable) button. Follow the steps to generate an SPID and Primary Key.\n - Then run the following command, including your newly generated SPID and primary key:\n\n ```\n python -m taxa_sdk.install_intel_keys [SPID] [primary key]\n ```\n\n4. If you are on OSX, you need to install the Apple signed libraries:\n\n```\nsudo python -m taxa_sdk.install_osx_libs\n```\n\n(Note the requirement of sudo)\n\n\n## Documentation\n\nThe documentation for this SDK can be found [here](https://docs.taxa.network/python-sdk).\n\n## Running tests\n\nTo run the tests for this module, run the following commands:\n\n### Testing through the WebUI\n\nTo test just the attestation process, using the WebUI:\n```\npython -m taxa_sdk.tests TestAttestationWebUI\n```\n\nTo test the full millionaire test using the WebUI, run this command:\n```\npython -m taxa_sdk.tests TestMillionaireByIdentity\n```\n\nNote: If you want to limit your tests to just a WebUI running of a specific server,\nthen modify the `FORCEIP` variable at the top of `taxa_sdk/tests.py`. If `FORCEIP`\nis set to `None` (The default), then the node distributer will pick a server\nfor you.\n\nAlso note that all tests ran though the WebUI will use the version of\n`taxa_client` that comes bundled with the SDK.\n\n### Running tests through the command line (bypassing WebUI)\n\nTo run the millionaire test via `taxa_server` via command line, bypassing the\nWebUI, then use the following command:\n\n```\npython -m taxa_sdk.tests TestBypassWebUI\n```\n\nTo just run the attestation via the `taxa_server` via command line, use this\ncommand:\n```\npython -m taxa_sdk.tests TestBypassWebUI.test_attestation\n```\n\nNote: you must modify the tests.py file at the top to include the paths to the\ncommand line `taxa_client` and `taxa_server` to do the `BypassWebUI` tests.\n\n### Testing parameters\n\nThere are a few things you can change via the command line. These extra\\\nparameters must be placed *before* the name of the test classes.\n\n#### --forceip\n\n```\npython -m taxa_sdk.tests --forceip=13.92.194.125 TestMillionaireByIdentity\n```\n\nThis will force the test to run on the node at the passed in IP. If this option\nis not used, the ip will be gotten from the P2P network.\n\n#### --nop2p\n\nThis will force the IP to be gotten from the node distributor web service instead\nof the P2P network.\n\n\n#### --keepkeys\n\nBy default all tests delete their keys after finishing. With this option included,\nthe keys will not be deleted. This means you can run the tests over and over, and it\nwill skip attestation. hence speeding up the tests.\n\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Developer SDK for the Taxa Network",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/taxa-network/taxa-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5bc112d20ff206c4fa74d1ff36a1d3df37312322802a5d7a660d38f5f0b50e2",
"md5": "4560618abd158fd47758241c3ba8ba00",
"sha256": "96aabb65d9f2aa526bd906fc132b6afe906f74b0b235493de5afd361be31ffe4"
},
"downloads": -1,
"filename": "taxa-sdk-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "4560618abd158fd47758241c3ba8ba00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56546338,
"upload_time": "2023-07-06T13:36:48",
"upload_time_iso_8601": "2023-07-06T13:36:48.926949Z",
"url": "https://files.pythonhosted.org/packages/d5/bc/112d20ff206c4fa74d1ff36a1d3df37312322802a5d7a660d38f5f0b50e2/taxa-sdk-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-06 13:36:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "taxa-network",
"github_project": "taxa-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "taxa-sdk"
}
JSON
