evmchains 0.0.4__tar.gz → 0.0.5__tar.gz

{evmchains-0.0.4 → evmchains-0.0.5}/.github/workflows/test.yaml

@@ -61,7 +61,7 @@ jobs:
         strategy:
             matrix:
                 os: [ubuntu-latest, macos-latest]   # eventually add `windows-latest`
-                python-version: ["3.8", "3.9", "3.10", "3.11"]
+                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
         steps:
         - uses: actions/checkout@v3

evmchains-0.0.5/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Development
+
+To get started with working on the codebase, use the following steps prepare your local environment:
+
+```bash
+# clone the github repo and navigate into the folder
+git clone https://github.com/ApeWorX/evmchains.git
+cd evmchains
+
+# create and load a virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# install evmchains into the virtual environment
+python setup.py install
+
+# install the developer dependencies (-e is interactive mode)
+pip install -e .'[dev]'
+```
+
+## Pre-Commit Hooks
+
+We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors.
+Use of `pre-commit` is not a requirement, but is highly recommended.
+
+Install `pre-commit` locally from the root folder:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+Committing will now automatically run the local hooks and ensure that your commit passes all lint checks.
+
+## Pull Requests
+
+Pull requests are welcomed! Please adhere to the following:
+
+- Ensure your pull request passes our linting checks
+- Include test cases for any new functionality
+- Include any relevant documentation updates
+
+It's a good idea to make pull requests early on.
+A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.
+
+If you are opening a work-in-progress pull request to verify that it passes CI tests, please consider
+[marking it as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests).
+
+Join the ApeWorX [Discord](https://discord.gg/apeworx) if you have any questions.

{evmchains-0.0.4 → evmchains-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.4
+Version: 0.0.5
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -218,6 +218,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -277,3 +278,13 @@ assert chain.chainId == 1
 
 Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
 Comments, questions, criticisms and pull requests are welcomed.
+
+### Adding Chains
+
+To add a chain to the metadata, please open a pull request with the following changes:
+
+- Update `CHAIN_IDS` in `scripts/update.py` with the chain IDs you want to add
+- Run `python scripts/update.py`
+- Submit a PR with the updated script and updated `evmchain/chains.py` metdata file
+
+**Do not edit `evmchain/chains.py` manually.** Any manual changes are likely to be overwritten later.

{evmchains-0.0.4 → evmchains-0.0.5}/README.md

@@ -42,3 +42,13 @@ assert chain.chainId == 1
 
 Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
 Comments, questions, criticisms and pull requests are welcomed.
+
+### Adding Chains
+
+To add a chain to the metadata, please open a pull request with the following changes:
+
+- Update `CHAIN_IDS` in `scripts/update.py` with the chain IDs you want to add
+- Run `python scripts/update.py`
+- Submit a PR with the updated script and updated `evmchain/chains.py` metdata file
+
+**Do not edit `evmchain/chains.py` manually.** Any manual changes are likely to be overwritten later.

{evmchains-0.0.4 → evmchains-0.0.5}/evmchains/_meta.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.4'
-__version_tuple__ = version_tuple = (0, 0, 4)
+__version__ = version = '0.0.5'
+__version_tuple__ = version_tuple = (0, 0, 5)

{evmchains-0.0.4 → evmchains-0.0.5}/evmchains.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.4
+Version: 0.0.5
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -218,6 +218,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -277,3 +278,13 @@ assert chain.chainId == 1
 
 Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
 Comments, questions, criticisms and pull requests are welcomed.
+
+### Adding Chains
+
+To add a chain to the metadata, please open a pull request with the following changes:
+
+- Update `CHAIN_IDS` in `scripts/update.py` with the chain IDs you want to add
+- Run `python scripts/update.py`
+- Submit a PR with the updated script and updated `evmchain/chains.py` metdata file
+
+**Do not edit `evmchain/chains.py` manually.** Any manual changes are likely to be overwritten later.

{evmchains-0.0.4 → evmchains-0.0.5}/evmchains.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 .gitignore
+CONTRIBUTING.md
 LICENSE
 README.md
 pyproject.toml

{evmchains-0.0.4 → evmchains-0.0.5}/pyproject.toml

@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
     "pydantic~=2.5.3",
@@ -54,7 +55,7 @@ write_to = "evmchains/_meta.py"
 # character.
 
 [tool.black]
-target-version = ['py38', 'py39', 'py310', 'py311']
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
 include = '\.pyi?$'
 
 [tool.pytest.ini_options]

{evmchains-0.0.4 → evmchains-0.0.5}/scripts/update.py

@@ -132,7 +132,7 @@ def fetch_chains() -> Dict[str, Dict[str, Chain]]:
 
 def write_chain_const(chains: Dict[str, Dict[str, Chain]]):
     """Write the file with Python constant"""
-    file_str = "# This file is auto-generated by scripts/update_rpc.py\n"
+    file_str = "# This file is auto-generated by scripts/update.py\n"
     file_str += f"# {stamp()}\n"
     file_str += "# Do not edit this file directly.\n"
     file_str += "from typing import Any, Dict\n\n"