eth-pydantic-types 0.1.0__tar.gz

eth-pydantic-types-0.1.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ApeWorX

eth-pydantic-types-0.1.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Report an error that you've encountered.
+labels: 'category: bug'
+---
+
+### Environment information
+
+- OS: macOS / linux / win
+- Python Version: x.x.x
+- `ape` and plugin versions:
+
+```sh
+$ ape --version
+# ...copy and paste result of above command here...
+
+$ ape plugins list
+# ...copy and paste result of above command here...
+```
+
+- Contents of your `ape-config.yaml` (NOTE: do not post anything private like RPC urls or secrets!):
+
+```sh
+$ cat ape-config.yaml
+# ...copy and paste result of above command here...
+```
+
+### What went wrong?
+
+Please include information like:
+
+- what command you ran
+- the code that caused the failure (see [this link](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for help with formatting code)
+- full output of the error you received
+
+### How can it be fixed?
+
+Fill this in if you have ideas on how the bug could be fixed.

eth-pydantic-types-0.1.0/.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Request a new feature, or an improvement to existing functionality.
+labels: 'category: feature'
+---
+
+### Overview
+
+Provide a simple overview of what you wish to see added. Please include:
+
+- What you are trying to do
+- Why Ape's current functionality is inadequate to address your goal
+
+### Specification
+
+Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better!
+
+Remember, your feature is much more likely to be included if it does not involve any breaking changes.
+
+### Dependencies
+
+Include links to any open issues that must be resolved before this feature can be implemented.

eth-pydantic-types-0.1.0/.github/ISSUE_TEMPLATE/work-item.md

@@ -0,0 +1,47 @@
+---
+name: Work item
+about: New work item for Ape team
+---
+
+### Elevator pitch:
+
+<!-- 1-2 line summary of the scope of this work item -->
+
+### Value:
+
+<!--
+  Who is this for?
+  Persona or group of people whom will derive value from the scenario.
+  What benefits will be achieved or business metrics improved?
+-->
+
+### Dependencies:
+
+<!-- Call out key people, teams, tech dependencies, or assumptions. -->
+
+### Design approach:
+
+<!--
+  Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list.
+  Existing code patterns in production code base that you will base your work off of.
+-->
+
+### Task list:
+
+<!-- Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. -->
+
+- \[ \] Tasks go here
+
+### Estimated completion date:
+
+### Design review:
+
+<!-- 1-2 people needed for signoff -->
+
+Do not signoff unless:
+
+- 1. agreed the tasks and design approach will achieve acceptance, and
+- 2. the work can be completed by one person within the SLA.
+     Design reviewers should consider simpler approaches to achieve goals.
+
+(Please leave a comment to sign off)

eth-pydantic-types-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+### What I did
+
+<!-- Create a summary of the changes -->
+
+<!-- The `fixes:` field denotes an issue that will be marked resolved by merging this PR -->
+
+fixes: #
+
+### How I did it
+
+<!-- Discuss the thought process behind the change -->
+
+### How to verify it
+
+<!-- Discuss any methods that should be used to verify the change -->
+
+### Checklist
+
+<!-- All PRs must complete the following checklist before being merged -->
+
+- [ ] All changes are completed
+- [ ] New test cases have been added
+- [ ] Documentation has been updated

eth-pydantic-types-0.1.0/.github/release-drafter.yml

@@ -0,0 +1,39 @@
+name-template: '$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+categories:
+  - title: 'Features'
+    labels:
+      - 'feat'
+  - title: 'Bug Fixes'
+    labels:
+      - 'fix'
+  - title: 'Other updates'
+    labels:
+      - 'refactor'
+      - 'chore'
+      - 'docs'
+      - 'perf'
+      - 'test'
+
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+
+template: |
+  ## Changes
+
+  $CHANGES
+
+  Special thanks to: $CONTRIBUTORS

eth-pydantic-types-0.1.0/.github/workflows/codeql.yml

@@ -0,0 +1,34 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: python
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

eth-pydantic-types-0.1.0/.github/workflows/commitlint.yaml

@@ -0,0 +1,28 @@
+on: push
+
+name: Commit Message
+
+# NOTE: Skip check on PR so as not to confuse contributors
+# NOTE: Also install a PR title checker so we don't mess up merges
+jobs:
+    commit-msg:
+
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+          with:
+              fetch-depth: 0
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: "3.10"
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -r cz-requirement.txt
+
+        - name: Check commit history
+          run: cz check --rev-range $(git rev-list --all --reverse | head -1)..HEAD

eth-pydantic-types-0.1.0/.github/workflows/docs.yaml

@@ -0,0 +1,59 @@
+name: Docs
+
+on:
+    push:
+        branches: [main]
+    release:
+        types: [released]
+    pull_request:
+        types: [opened, synchronize]
+
+jobs:
+    docs:
+        runs-on: ubuntu-latest
+        permissions:
+          contents: write
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: "3.10"
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install .[doc]
+
+        - name: Build HTML artifact
+          run: python build_docs.py
+
+        - name: Upload HTML artifact
+          uses: actions/upload-artifact@v3
+          with:
+              name: DocumentationHTML
+              path: docs/_build/ape
+
+        - name: Commit and publish documentation changes to gh-pages branch
+          run: |
+              if [[ "${GITHUB_EVENT_NAME}" =~ "pull_request" ]]; then
+                echo "skipping 'git commit' step for PR"
+              else
+                git clone https://github.com/${GITHUB_REPOSITORY} --branch gh-pages --single-branch gh-pages
+                cp -r docs/_build/eth_pydantic_types/* gh-pages/
+                cd gh-pages
+                touch .nojekyll
+                git config --local user.email "action@github.com"
+                git config --local user.name "GitHub Action"
+                git add .
+                git commit -m "Update documentation" -a || true
+              fi
+        - name: Push changes
+          uses: ad-m/github-push-action@master
+          if: ${{ github.event_name != 'pull_request' }}
+          with:
+              branch: gh-pages
+              directory: gh-pages
+              github_token: ${{ secrets.GITHUB_TOKEN }}

eth-pydantic-types-0.1.0/.github/workflows/draft.yaml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update-draft:
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "main"
+      - uses: release-drafter/release-drafter@v5
+        with:
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

eth-pydantic-types-0.1.0/.github/workflows/prtitle.yaml

@@ -0,0 +1,30 @@
+name: PR Title
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+    pr-title:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: "3.10"
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -r cz-requirement.txt
+
+        - name: Check PR Title
+          env:
+              TITLE: ${{ github.event.pull_request.title }}
+          run: cz check --message "$TITLE"

eth-pydantic-types-0.1.0/.github/workflows/publish.yaml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[release]
+
+    - name: Build
+      run: python setup.py sdist bdist_wheel
+
+    - name: Publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: twine upload dist/*

eth-pydantic-types-0.1.0/.github/workflows/stale-prs.yml

@@ -0,0 +1,20 @@
+name: "Close stale PRs"
+on:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v6
+        with:
+          stale-pr-message: 'This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.'
+          close-pr-message: 'This PR was closed because it has been inactive for 35 days.'
+          stale-pr-label: "stale"
+          close-pr-label: "inactive"
+          days-before-pr-stale: 30
+          days-before-pr-close: 5
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

eth-pydantic-types-0.1.0/.github/workflows/test.yaml

@@ -0,0 +1,110 @@
+on: ["push", "pull_request"]
+
+name: Test
+
+concurrency:
+  # Cancel older, in-progress jobs from the same PR, same workflow.
+  # use run_id if the job is triggered by a push to ensure
+  # push-triggered jobs to not get canceled.
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+    linting:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: "3.10"
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install .[lint]
+
+        - name: Run Black
+          run: black --check .
+
+        - name: Run isort
+          run: isort --check-only .
+
+        - name: Run flake8
+          run: flake8 .
+
+        - name: Run mdformat
+          run: mdformat . --check
+
+    type-check:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v3
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: "3.10"
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install .[lint,test]
+
+        - name: Run MyPy
+          run: mypy .
+
+    functional:
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            matrix:
+                os: [ubuntu-latest, macos-latest]   # eventually add `windows-latest`
+                python-version: [3.8, 3.9, "3.10", "3.11", "3.12"]
+
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        steps:
+        - uses: actions/checkout@v3
+          with:
+            fetch-depth: 0
+
+        - name: Setup Python
+          uses: actions/setup-python@v4
+          with:
+              python-version: ${{ matrix.python-version }}
+
+        - name: Install Dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip uninstall eth-ape --yes
+            pip install .[test]
+
+        - name: Run Tests
+          run: pytest -m "not fuzzing" -s
+
+#    fuzzing:
+#        runs-on: ubuntu-latest
+#
+#        strategy:
+#            fail-fast: true
+#
+#        steps:
+#        - uses: actions/checkout@v3
+#
+#        - name: Setup Python
+#          uses: actions/setup-python@v4
+#          with:
+#              python-version: "3.10"
+#
+#        - name: Install Dependencies
+#          run: |
+#            python -m pip install --upgrade pip
+#            pip install .[test]
+#
+#        - name: Run Tests
+#          run: pytest -m "fuzzing" --no-cov -s

eth-pydantic-types-0.1.0/.gitignore

@@ -0,0 +1,156 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.build/
+eth_pydantic_types/version.py