## Background
Command line tool and SDK for interacting with the Tellor Protocol.
The package `telliot-core` version `0.3.0` forked from:<br />
https://github.com/tellor-io/telliot-core
## Initial Setup
### Prerequisites
The following tools are expected to be installed on your system to run this project:
- Python 3.9.x
- Pip 23.3.x
- Git
### Setup
```bash
python3.9 -m venv tenv
source tenv/bin/activate
pip3.9 install .
```
NPM ganache dependency required:
```bash
npm install ganache --global
```
### Test
Install development requirements:
```bash
pip3.9 install -r requirements-dev.txt
```
Run automated testing in all environments:
```bash
tox
```
Run `py39` testing:
```bash
tox -e py39
```
Run `style` testing:
```bash
tox -e style
```
Run `typing` typing:
```bash
tox -e typing
```
### Publish
1. Create the `$HOME/.pypirc` file:
```
[pypi]
username = __token__
password = pypi-AgEIcHlw... (your PyPI token)
```
2. Build distribution:
```bash
python3.9 -m build
```
3. Deploy distribution to PyPI repository:
```bash
twine upload dist/*
```
## Usage
### Configuration
1. Create the default configuration files:
```bash
telliot-core config init
```
The default configuration files are created in the folder `~/telliot/` or `$HOME/telliot/`.
2. View your current configuration:
```bash
telliot-core config show
```
## Contributing
Bug reports and pull requests are welcome on GitHub at:<br />
https://github.com/SELISEdigitalplatforms/l3-solidity-bcts-tellor
Raw data
{
"_id": null,
"home_page": "",
"name": "bcts-telliotcore",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "oracle,etherium,blockchain",
"author": "Blockchain Trust Solutions AG",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0c/4b/da49f641daa20cd0517ee08fb65c9c102fe6b54bc6109618d3c7043b31e7/bcts_telliotcore-1.0.3.tar.gz",
"platform": null,
"description": "## Background\n\nCommand line tool and SDK for interacting with the Tellor Protocol.\n\nThe package `telliot-core` version `0.3.0` forked from:<br />\nhttps://github.com/tellor-io/telliot-core\n\n## Initial Setup\n\n### Prerequisites\nThe following tools are expected to be installed on your system to run this project:\n\n- Python 3.9.x\n- Pip 23.3.x\n- Git\n\n### Setup\n\n```bash\npython3.9 -m venv tenv\nsource tenv/bin/activate\npip3.9 install .\n```\n\nNPM ganache dependency required:\n```bash\nnpm install ganache --global\n```\n\n### Test\n\nInstall development requirements:\n```bash\npip3.9 install -r requirements-dev.txt\n```\n\nRun automated testing in all environments:\n```bash\ntox\n```\n\nRun `py39` testing:\n```bash\ntox -e py39\n```\n\nRun `style` testing:\n```bash\ntox -e style\n```\n\nRun `typing` typing:\n```bash\ntox -e typing\n```\n\n### Publish\n\n1. Create the `$HOME/.pypirc` file:\n```\n[pypi]\n username = __token__\n password = pypi-AgEIcHlw... (your PyPI token)\n```\n\n2. Build distribution:\n```bash\npython3.9 -m build\n```\n\n3. Deploy distribution to PyPI repository:\n```bash\ntwine upload dist/*\n```\n\n## Usage\n\n### Configuration\n\n1. Create the default configuration files:\n```bash\ntelliot-core config init\n```\n\nThe default configuration files are created in the folder `~/telliot/` or `$HOME/telliot/`.\n\n2. View your current configuration:\n```bash\ntelliot-core config show\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at:<br />\nhttps://github.com/SELISEdigitalplatforms/l3-solidity-bcts-tellor\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Telliot is a Python framework for interacting with the decentralized TellorX network.",
"version": "1.0.3",
"project_urls": null,
"split_keywords": [
"oracle",
"etherium",
"blockchain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9090f4d99b39720d3603ce487d3f2e06b58f762c3b1922d77d990c19405e909d",
"md5": "86530e3e6616ec84d5a4adab7a5b2524",
"sha256": "ec25f5014171611668e2968541bf204d3bb5c1b788e717f2984de6896ee44597"
},
"downloads": -1,
"filename": "bcts_telliotcore-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86530e3e6616ec84d5a4adab7a5b2524",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 67201,
"upload_time": "2023-12-01T15:45:10",
"upload_time_iso_8601": "2023-12-01T15:45:10.424813Z",
"url": "https://files.pythonhosted.org/packages/90/90/f4d99b39720d3603ce487d3f2e06b58f762c3b1922d77d990c19405e909d/bcts_telliotcore-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c4bda49f641daa20cd0517ee08fb65c9c102fe6b54bc6109618d3c7043b31e7",
"md5": "db54af17b4d2d1a47b167c848e1ef29b",
"sha256": "2776171510aa1c111a31da266ecb613280d594aa53fd0a9614529cae8eb3a870"
},
"downloads": -1,
"filename": "bcts_telliotcore-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "db54af17b4d2d1a47b167c848e1ef29b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 64248,
"upload_time": "2023-12-01T15:45:12",
"upload_time_iso_8601": "2023-12-01T15:45:12.362522Z",
"url": "https://files.pythonhosted.org/packages/0c/4b/da49f641daa20cd0517ee08fb65c9c102fe6b54bc6109618d3c7043b31e7/bcts_telliotcore-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 15:45:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bcts-telliotcore"
}
JSON