## Background
Reporting tools and datafeeds for Tellor oracles.
The package `telliot-feeds` version `0.1.14` forked from:<br />
https://github.com/tellor-io/telliot-feeds
## 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 .
```
### 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
### Using Docker
1. Create & start container in the background:
```bash
docker compose up -d
```
2. Execute commands in a running Docker container:
```bash
docker exec -it telliot sh
```
### Configuration
1. Create the default configuration files:
```bash
telliot config init
```
The default configuration files are created in a folder called `telliot` in the user's home folder.
2. View your current configuration:
```bash
telliot config show
```
### Using Telliot
1. Add Reporting account:
```bash
telliot account add fantomacct1 5d18c4aabe8f0ee841e2e0ee504c7d9ec98d2aa9edb2e44d5e8825ec0670f896 4002
```
2. Check Reporting account:
```bash
telliot account find
```
3. Using StakingToken smart contract address provided below, mint 1000 TTRB tokens to the `fantomacct1` account:<br />
`0x8e4E5eDab27Df5a93B25AC3a62b80beec1CfEBd0`
4. Report data with the `fantomacct1` account to the Tellor Oracle:
```bash
telliot report -a fantomacct1 -ncr -qt trb-usd-spot
```
## Contributing
Bug reports and pull requests are welcome on GitHub at:<br />
https://github.com/BCTSAG/tellor
Raw data
{
"_id": null,
"home_page": "",
"name": "bctsag-telliotfeeds",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "oracle,ethereum,blockchain",
"author": "Blockchain Trust Solutions AG",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/bc/4c/1762b59e6ba586499cbd08c9accbd162111f5c90dbd566482fff7d995a70/bctsag_telliotfeeds-1.0.1.tar.gz",
"platform": null,
"description": "## Background\n\nReporting tools and datafeeds for Tellor oracles.\n\nThe package `telliot-feeds` version `0.1.14` forked from:<br />\nhttps://github.com/tellor-io/telliot-feeds\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\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### Using Docker\n\n1. Create & start container in the background:\n```bash\ndocker compose up -d\n```\n\n2. Execute commands in a running Docker container:\n```bash\ndocker exec -it telliot sh\n```\n\n### Configuration\n\n1. Create the default configuration files:\n```bash\ntelliot config init\n```\n\nThe default configuration files are created in a folder called `telliot` in the user's home folder.\n\n2. View your current configuration:\n```bash\ntelliot config show\n```\n### Using Telliot\n\n1. Add Reporting account:\n```bash\ntelliot account add fantomacct1 5d18c4aabe8f0ee841e2e0ee504c7d9ec98d2aa9edb2e44d5e8825ec0670f896 4002\n```\n\n2. Check Reporting account:\n```bash\ntelliot account find\n```\n\n3. Using StakingToken smart contract address provided below, mint 1000 TTRB tokens to the `fantomacct1` account:<br />\n`0x8e4E5eDab27Df5a93B25AC3a62b80beec1CfEBd0`\n\n\n4. Report data with the `fantomacct1` account to the Tellor Oracle:\n```bash\ntelliot report -a fantomacct1 -ncr -qt trb-usd-spot\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at:<br />\nhttps://github.com/BCTSAG/tellor\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools for interacting with Tellor Protocol smart contracts.",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"oracle",
"ethereum",
"blockchain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f700740f42a473c0ec1f1ad970c213a0bd03d1bdc4699f0b29ad4ef6412d4781",
"md5": "5886056fb7a4a6f01be0e5acbc10d78f",
"sha256": "2ce4cc0a531bcb43a2b8a5b6ac616a5c6e78df3290e852a69c83222abbeb0a35"
},
"downloads": -1,
"filename": "bctsag_telliotfeeds-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5886056fb7a4a6f01be0e5acbc10d78f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 227347,
"upload_time": "2023-12-01T16:53:23",
"upload_time_iso_8601": "2023-12-01T16:53:23.322571Z",
"url": "https://files.pythonhosted.org/packages/f7/00/740f42a473c0ec1f1ad970c213a0bd03d1bdc4699f0b29ad4ef6412d4781/bctsag_telliotfeeds-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc4c1762b59e6ba586499cbd08c9accbd162111f5c90dbd566482fff7d995a70",
"md5": "90cbc8b68990f20521c5ee2f604226e1",
"sha256": "cc04a667e726aa771f0289a957f5379cdd3b71e0d422d4ab93ebeb5c4f02e74c"
},
"downloads": -1,
"filename": "bctsag_telliotfeeds-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "90cbc8b68990f20521c5ee2f604226e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 226577,
"upload_time": "2023-12-01T16:53:26",
"upload_time_iso_8601": "2023-12-01T16:53:26.073860Z",
"url": "https://files.pythonhosted.org/packages/bc/4c/1762b59e6ba586499cbd08c9accbd162111f5c90dbd566482fff7d995a70/bctsag_telliotfeeds-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 16:53:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bctsag-telliotfeeds"
}
JSON