merge template

Author: pacrob

.bumpversion.cfg

@@ -101,10 +101,12 @@ docs: &docs
         name: install latexpdf dependencies
         command: |
           sudo apt-get update
-          sudo apt-get install latexmk tex-gyre texlive-fonts-extra
+          sudo apt-get install latexmk tex-gyre texlive-fonts-extra texlive-xetex xindy
     - run:
         name: run tox
         command: python -m tox run -r
+    - store_artifacts:
+          path: /home/circleci/repo/docs/_build
     - save_cache:
         paths:
           - .tox
@@ -117,7 +119,7 @@ jobs:
   docs:
     <<: *docs
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.10
         environment:
           TOXENV: docs
 
@@ -151,6 +153,12 @@ jobs:
       - image: cimg/python:3.12
         environment:
           TOXENV: py312-core
+  py313-core:
+    <<: *common
+    docker:
+      - image: cimg/python:3.13
+        environment:
+          TOXENV: py313-core
 
   py38-lint:
     <<: *common
@@ -182,6 +190,12 @@ jobs:
       - image: cimg/python:3.12
         environment:
           TOXENV: py312-lint
+  py313-lint:
+    <<: *common
+    docker:
+      - image: cimg/python:3.13
+        environment:
+          TOXENV: py313-lint
 
   py38-wheel:
     <<: *common
@@ -213,6 +227,12 @@ jobs:
       - image: cimg/python:3.12
         environment:
           TOXENV: py312-wheel
+  py313-wheel:
+    <<: *common
+    docker:
+      - image: cimg/python:3.13
+        environment:
+          TOXENV: py313-wheel
 
   py311-windows-wheel:
     <<: *windows-wheel-setup
@@ -240,25 +260,42 @@ jobs:
       - <<: *run-tox-step
       - <<: *save-cache-step
 
+  py313-windows-wheel:
+    <<: *windows-wheel-setup
+    steps:
+      - checkout
+      - <<: *restore-cache-step
+      - <<: *install-pyenv-step
+      - run:
+          name: set minor version
+          command: echo "export MINOR_VERSION='3.13'" >> $BASH_ENV
+      - <<: *install-latest-python-step
+      - <<: *run-tox-step
+      - <<: *save-cache-step
+
 define: &all_jobs
   - docs
   - py38-core
   - py39-core
   - py310-core
   - py311-core
   - py312-core
+  - py313-core
   - py38-lint
   - py39-lint
   - py310-lint
   - py311-lint
   - py312-lint
+  - py313-lint
   - py38-wheel
   - py39-wheel
   - py310-wheel
   - py311-wheel
   - py312-wheel
+  - py313-wheel
   - py311-windows-wheel
   - py312-windows-wheel
+  - py313-windows-wheel
 
 workflows:
   version: 2

.circleci/config.yml

@@ -8,9 +8,7 @@ Closes #
 ### Todo:
 
 - [ ] Clean up commit history
-
 - [ ] Add or update documentation related to these changes
-
 - [ ] Add entry to the [release notes](https://github.com/ethereum/eth-typing/blob/main/newsfragments/README.md)
 
 #### Cute Animal Picture

.github/pull_request_template.md

@@ -83,6 +83,9 @@ logs
 # vs-code
 .vscode
 
+# jupyter notebook files
+*.ipynb
+
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # For a more precise, explicit template, see:
 # https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

.gitignore

@@ -1,4 +1,4 @@
-exclude: '.project-template|docs/conf.py|.bumpversion.cfg'
+exclude: '.project-template|docs/conf.py'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
@@ -52,7 +52,15 @@ repos:
         always_run: true
         pass_filenames: false
 -   repo: https://github.com/PrincetonUniversity/blocklint
-    rev: v0.2.4
+    rev: v0.2.5
     hooks:
     -   id: blocklint
-        exclude: 'docs/Makefile|docs/release_notes.rst'
+        exclude: 'docs/Makefile|docs/release_notes.rst|tox.ini'
+-   repo: local
+    hooks:
+    -   id: check-rst-files
+        name: Check for .rst files in the top-level directory
+        entry: sh -c 'ls *.rst 1>/dev/null 2>&1 && { echo "found .rst file in top-level folder"; exit 1; } || exit 0'
+        language: system
+        always_run: true
+        pass_filenames: false

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.10"
 
 sphinx:
   configuration: docs/conf.py

.readthedocs.yaml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2023 The Ethereum Foundation
+Copyright (c) 2018-2025 The Ethereum Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,6 +1,7 @@
 include LICENSE
 include README.md
 
+recursive-include scripts *
 recursive-include tests *
 
 global-include *.pyi

MANIFEST.in

@@ -5,87 +5,109 @@ CURRENT_SIGN_SETTING := $(shell git config commit.gpgSign)
 help:
 	@echo "clean-build - remove build artifacts"
 	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean - run clean-build and clean-pyc"
+	@echo "dist - build package and cat contents of the dist directory"
 	@echo "lint - fix linting issues with pre-commit"
 	@echo "test - run tests quickly with the default Python"
 	@echo "docs - generate docs and open in browser (linux-docs for version on linux)"
-	@echo "notes - consume towncrier newsfragments/ and update release notes in docs/"
-	@echo "release - package and upload a release (does not run notes target)"
-	@echo "dist - package"
-
-clean: clean-build clean-pyc
+	@echo "autobuild-docs - live update docs when changes are saved"
+	@echo "package-test - build package and install it in a venv for manual testing"
+	@echo "notes - consume towncrier newsfragments and update release notes in docs - requires bump to be set"
+	@echo "release - package and upload a release (does not run notes target) - requires bump to be set"
 
 clean-build:
 	rm -fr build/
 	rm -fr dist/
+	rm -fr *.egg-info
 
 clean-pyc:
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -rf {} +
 
+clean: clean-build clean-pyc
+
+dist: clean
+	python -m build
+	ls -l dist
+
 lint:
 	@pre-commit run --all-files --show-diff-on-failure || ( \
 		echo "\n\n\n * pre-commit should have fixed the errors above. Running again to make sure everything is good..." \
 		&& pre-commit run --all-files --show-diff-on-failure \
 	)
 
 test:
-	pytest tests
+	python -m pytest tests
 
-build-docs:
-	sphinx-apidoc -o docs/ . setup.py "*conftest*"
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
-	$(MAKE) -C docs doctest
+# docs commands
 
-build-docs-ci:
-	$(MAKE) -C docs latexpdf
-	$(MAKE) -C docs epub
+docs: check-docs
+	open docs/_build/html/index.html
+
+linux-docs: check-docs
+	xdg-open docs/_build/html/index.html
+
+autobuild-docs:
+	sphinx-autobuild --open-browser docs docs/_build/html
+
+# docs helpers
 
 validate-newsfragments:
 	python ./newsfragments/validate_files.py
 	towncrier build --draft --version preview
 
 check-docs: build-docs validate-newsfragments
 
+build-docs:
+	sphinx-apidoc -o docs/ . setup.py "*conftest*"
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(MAKE) -C docs doctest
+
 check-docs-ci: build-docs build-docs-ci validate-newsfragments
 
-docs: check-docs
-	open docs/_build/html/index.html
+build-docs-ci:
+	$(MAKE) -C docs latexpdf
+	$(MAKE) -C docs epub
 
-linux-docs: check-docs
-	xdg-open docs/_build/html/index.html
+# release commands
 
-check-bump:
-ifndef bump
-	$(error bump must be set, typically: major, minor, patch, or devnum)
-endif
+package-test: clean
+	python -m build
+	python scripts/release/test_package.py
 
-notes: check-bump validate-newsfragments
+notes: check-bump
 	# Let UPCOMING_VERSION be the version that is used for the current bump
-	$(eval UPCOMING_VERSION=$(shell bumpversion $(bump) --dry-run --list | grep new_version= | sed 's/new_version=//g'))
+	$(eval UPCOMING_VERSION=$(shell bump-my-version bump --dry-run $(bump) -v | awk -F"'" '/New version will be / {print $$2}'))
 	# Now generate the release notes to have them included in the release commit
 	towncrier build --yes --version $(UPCOMING_VERSION)
 	# Before we bump the version, make sure that the towncrier-generated docs will build
 	make build-docs
 	git commit -m "Compile release notes for v$(UPCOMING_VERSION)"
 
-release: check-bump clean
-	# require that upstream is configured for ethereum/eth-typing
-	@git remote -v | grep "upstream[[:space:]][email protected]:ethereum/eth-typing.git (push)\|upstream[[:space:]]https://github.com/ethereum/eth-typing (push)"
-	# verify that docs build correctly
+release: check-bump check-git clean
+	# verify that notes command ran correctly
 	./newsfragments/validate_files.py is-empty
-	make build-docs
 	CURRENT_SIGN_SETTING=$(git config commit.gpgSign)
 	git config commit.gpgSign true
-	bumpversion $(bump)
+	bump-my-version bump $(bump)
 	python -m build
+	git config commit.gpgSign "$(CURRENT_SIGN_SETTING)"
 	git push upstream && git push upstream --tags
 	twine upload dist/*
-	git config commit.gpgSign "$(CURRENT_SIGN_SETTING)"
 
+# release helpers
 
-dist: clean
-	python -m build
-	ls -l dist
+check-bump:
+ifndef bump
+	$(error bump must be set, typically: major, minor, patch, or devnum)
+endif
+
+check-git:
+	# require that upstream is configured for ethereum/<REPO_NAME>
+	@if ! git remote -v | grep "upstream[[:space:]][email protected]:ethereum/<REPO_NAME>.git (push)\|upstream[[:space:]]https://github.com/ethereum/<REPO_NAME> (push)"; then \
+		echo "Error: You must have a remote named 'upstream' that points to '<REPO_NAME>'"; \
+		exit 1; \
+	fi