| Name | eips JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Ethereum Improvement Proposal (EIP) ETL library |
| upload_time | 2024-12-01 22:24:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright © 2023 Mike Shultz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
eip
ethereum
etl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
No coveralls.
|
# Ethereum Improvement Proposal (EIP) Processor
CLI tools and Python library for interacting with EIPs from the [source EIPs GitHub repository](https://github.com/ethereum/EIPs).
## Features/TODO
Frontend
- [X] CLI tools
- [X] Library API
- [ ] Documentation
Data processing:
- [X] EIP Metadata processing
- [ ] EIP relationships and references
- [ ] Automated tagging
- [ ] File history, changelog
- [X] Aggregate data, statistics, and error detection
- [ ] Indicate document deletion in some fashion (file flag, and empty props?)
## Usage
### Show EIP
```bash
eips show 712
```
### Show EIP Headers
```bash
eips show -i 4626
```
### Show ERC
```bash
eips show 20
```
## API Usage
### Get an EIP
```python
>>> from eips import EIPs
>>> eips = EIPs()
>>> eip_20 = eips.get(20)[0]
>>> eip_20.title
'Token Standard'
```
### Get all EIPs
```python
>>> from eips import EIPs
>>> eips = EIPs()
>>> for e in eips.get():
... print(e.eip_id)
...
2018
5216
999
606
[...]
```
### Get count of EIPs
```python
>>> from eips import EIPs
>>> eips = EIPs()
>>> eips.len()
687
```
### Get EIPs aggregate stats
```python
>>> from eips import EIPs
>>> eips = EIPs()
>>> eips.stats().total
687
>>> eips.stats().errors
0
>>> [c.value for c in eips.stats().categories]
['ERC', 'Core', 'Interface', 'Networking']
>>> [s.value for s in eips.stats().statuses]
['Stagnant', 'Last Call', 'Withdrawn', 'Final', 'Review', 'Draft', 'Living']
>>> [t.value for t in eips.stats().types]
['Standards Track', 'Meta', 'Informational']
```
## Development
### Run Tests
```bash
hatch run test
```
### Linting
```bash
hatch run lint
```
### Release
To release, create and publish a GitHub package release
```bash
# Bump the version major/minor/patch
hatch version patch
# Tag the git commit with the version
git tag -a "v$(hatch version)" -m "v$(hatch version)"
# Push it up to GH, don't forget the tag
git push --follow-tags
```
Now [create a GitHub release](https://github.com/mikeshultz/python-eips/releases/new) and CI will do the rest.
Raw data
{
"_id": null,
"home_page": null,
"name": "eips",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "eip, ethereum, etl",
"author": null,
"author_email": "Mike Shultz <mike@mikeshultz.com>",
"download_url": "https://files.pythonhosted.org/packages/a3/2d/c720c14580b0b5dc5564860f326d7783cefd60a829d81ad1c1636e336140/eips-0.2.0.tar.gz",
"platform": null,
"description": "# Ethereum Improvement Proposal (EIP) Processor\n\nCLI tools and Python library for interacting with EIPs from the [source EIPs GitHub repository](https://github.com/ethereum/EIPs).\n\n## Features/TODO\n\nFrontend\n\n- [X] CLI tools\n- [X] Library API\n- [ ] Documentation\n\nData processing:\n\n- [X] EIP Metadata processing\n- [ ] EIP relationships and references\n- [ ] Automated tagging\n- [ ] File history, changelog\n- [X] Aggregate data, statistics, and error detection\n- [ ] Indicate document deletion in some fashion (file flag, and empty props?)\n\n\n## Usage\n\n### Show EIP\n\n```bash\neips show 712\n```\n\n### Show EIP Headers\n\n```bash\neips show -i 4626\n```\n\n### Show ERC\n\n```bash\neips show 20\n```\n\n## API Usage\n\n### Get an EIP\n\n```python\n>>> from eips import EIPs\n>>> eips = EIPs()\n>>> eip_20 = eips.get(20)[0]\n>>> eip_20.title\n'Token Standard'\n```\n\n### Get all EIPs\n\n```python\n>>> from eips import EIPs\n>>> eips = EIPs()\n>>> for e in eips.get():\n... print(e.eip_id)\n... \n2018\n5216\n999\n606\n[...]\n```\n\n### Get count of EIPs\n\n```python\n>>> from eips import EIPs\n>>> eips = EIPs()\n>>> eips.len()\n687\n```\n\n### Get EIPs aggregate stats\n\n```python\n>>> from eips import EIPs\n>>> eips = EIPs()\n>>> eips.stats().total\n687\n>>> eips.stats().errors\n0\n>>> [c.value for c in eips.stats().categories]\n['ERC', 'Core', 'Interface', 'Networking']\n>>> [s.value for s in eips.stats().statuses]\n['Stagnant', 'Last Call', 'Withdrawn', 'Final', 'Review', 'Draft', 'Living']\n>>> [t.value for t in eips.stats().types]\n['Standards Track', 'Meta', 'Informational']\n```\n\n## Development\n\n### Run Tests\n\n```bash\nhatch run test\n```\n\n### Linting\n\n```bash\nhatch run lint\n```\n\n### Release\n\nTo release, create and publish a GitHub package release \n\n```bash\n# Bump the version major/minor/patch\nhatch version patch\n# Tag the git commit with the version\ngit tag -a \"v$(hatch version)\" -m \"v$(hatch version)\"\n# Push it up to GH, don't forget the tag\ngit push --follow-tags\n```\n\nNow [create a GitHub release](https://github.com/mikeshultz/python-eips/releases/new) and CI will do the rest.\n",
"bugtrack_url": null,
"license": "Copyright \u00a9 2023 Mike Shultz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Ethereum Improvement Proposal (EIP) ETL library",
"version": "0.2.0",
"project_urls": {
"source": "https://github.com/mikeshultz/eips"
},
"split_keywords": [
"eip",
" ethereum",
" etl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1257b4fafdc2f458166dde0fb586ff429c643db807338a69e49fc74ea1791ec6",
"md5": "0873fb36d9cfadac4015a57e26c67183",
"sha256": "584d0b91d40dbecf84204383307869c73db6b60bcccb08f493fbd3d3d7ef30d1"
},
"downloads": -1,
"filename": "eips-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0873fb36d9cfadac4015a57e26c67183",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 16004,
"upload_time": "2024-12-01T22:24:14",
"upload_time_iso_8601": "2024-12-01T22:24:14.222931Z",
"url": "https://files.pythonhosted.org/packages/12/57/b4fafdc2f458166dde0fb586ff429c643db807338a69e49fc74ea1791ec6/eips-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a32dc720c14580b0b5dc5564860f326d7783cefd60a829d81ad1c1636e336140",
"md5": "760e7d0843c1d870c4dcc6b6fe2e15ca",
"sha256": "13a1273472d7e5afc9854f3c358b93d62bdbe4a318774808b944cb679f57bf9b"
},
"downloads": -1,
"filename": "eips-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "760e7d0843c1d870c4dcc6b6fe2e15ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14450,
"upload_time": "2024-12-01T22:24:15",
"upload_time_iso_8601": "2024-12-01T22:24:15.840007Z",
"url": "https://files.pythonhosted.org/packages/a3/2d/c720c14580b0b5dc5564860f326d7783cefd60a829d81ad1c1636e336140/eips-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 22:24:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mikeshultz",
"github_project": "eips",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "eips"
}
