merge template and fill vars

Author: pacrob

.bumpversion.cfg

@@ -100,14 +100,11 @@ docs: &docs
         command: |
           python -m pip install --upgrade pip
           python -m pip install tox
-    - run:
-        name: install latexpdf dependencies
-        command: |
-          sudo apt-get update
-          sudo apt-get install latexmk tex-gyre texlive-fonts-extra
     - run:
         name: run tox
         command: python -m tox run -r
+    - store_artifacts:
+          path: /home/circleci/repo/docs/_build
     - save_cache:
         paths:
           - .tox
@@ -120,7 +117,7 @@ jobs:
   docs:
     <<: *docs
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.10
         environment:
           TOXENV: docs
 
@@ -154,6 +151,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
@@ -185,6 +188,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
@@ -216,6 +225,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
@@ -243,25 +258,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

@@ -81,6 +81,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
@@ -43,11 +43,6 @@ repos:
     -   id: mdformat
         additional_dependencies:
         -   mdformat-gfm
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
-    hooks:
-    -   id: mypy
-        exclude: 'tests/|trie/'
 -   repo: https://github.com/PrincetonUniversity/blocklint
     rev: v0.2.5
     hooks:

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+# Build all formats for RTD Downloads - htmlzip, pdf, epub
+formats: all

.readthedocs.yaml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2023 The Ethereum Foundation
+Copyright (c) 2017-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

@@ -5,25 +5,32 @@ 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 - view draft of newsfragments to be added to CHANGELOG"
-	@echo "notes - consume towncrier newsfragments/ and update CHANGELOG"
-	@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 "notes - consume towncrier newsfragments/ and update CHANGELOG - 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..." \
@@ -33,38 +40,48 @@ lint:
 test:
 	python -m pytest tests
 
+# docs commands
+
 docs:
 	python ./newsfragments/validate_files.py
 	towncrier build --draft --version preview
 
-check-bump:
-ifndef bump
-	$(error bump must be set, typically: major, minor, patch, or devnum)
-endif
+# release commands
+
+package-test: clean
+	python -m build
+	python scripts/release/test_package.py
 
 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 docs
 	git commit -m "Compile release notes for v$(UPCOMING_VERSION)"
 
-release: check-bump clean
-	# require that upstream is configured for ethereum/py-trie
-	@git remote -v | grep "upstream[[:space:]][email protected]:ethereum/py-trie.git (push)\|upstream[[:space:]]https://github.com/ethereum/py-trie (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 docs
 	CURRENT_SIGN_SETTING=$(git config commit.gpgSign)
 	git config commit.gpgSign true
-	bumpversion $(bump)
-	git push upstream && git push upstream --tags
+	bump-my-version bump $(bump)
 	python -m build
-	twine upload dist/*
 	git config commit.gpgSign "$(CURRENT_SIGN_SETTING)"
+	git push upstream && git push upstream --tags
+	twine upload dist/*
 
-dist: clean
-	python -m build
-	ls -l dist
+# release helpers
+
+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/py-trie
+	@if ! git remote -v | grep "upstream[[:space:]][email protected]:ethereum/py-trie.git (push)\|upstream[[:space:]]https://github.com/ethereum/py-trie (push)"; then \
+		echo "Error: You must have a remote named 'upstream' that points to 'py-trie'"; \
+		exit 1; \
+	fi

Makefile

@@ -8,6 +8,10 @@
 > This library and repository was previously located at [pipermerriam/py-trie](https://github.com/pipermerriam/py-trie). It was transferred to the Ethereum foundation GitHub in
 > November 2017 and renamed to `py-trie`.
 
+Read more in the documentation below.
+
+View the [change log](https://github.com/ethereum/py-trie/blob/main/CHANGELOG.rst).
+
 ## Installation
 
 ```sh
@@ -69,10 +73,10 @@ like `make release bump=minor` or `make release bump=devnum`. This is typically
 main branch, except when releasing a beta (in which case the beta is released from main,
 and the previous stable branch is released from said branch).
 
-If you are in a beta version, `bumpversion stage` will switch to a stable.
+If you are in a beta version, `make release bump=stage` will switch to a stable.
 
 To issue an unstable version when the current version is stable, specify the
-new version explicitly, like `bumpversion --new-version 4.0.0-alpha.1 devnum`
+new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`
 
 ## Usage
 

README.md

@@ -0,0 +1 @@
+Merge template, adding py313 to CI and replacing ``bumpversion`` with ``bump-my-version``.

newsfragments/156.feature.rst

@@ -7,6 +7,7 @@ combine_as_imports = true
 extra_standard_library = "pytest"
 force_grid_wrap = 1
 force_sort_within_sections = true
+force_to_top = "pytest"
 honor_noqa = true
 known_first_party = "trie"
 known_third_party = "hypothesis"
@@ -122,3 +123,46 @@ showcontent = true
 directory = "removal"
 name = "Removals"
 showcontent = true
+
+[tool.bumpversion]
+current_version = "3.0.1"
+parse = """
+    (?P<major>\\d+)
+    \\.(?P<minor>\\d+)
+    \\.(?P<patch>\\d+)
+		(-
+			(?P<stage>[^.]*)
+			\\.(?P<devnum>\\d+)
+		)?
+"""
+serialize = [
+	"{major}.{minor}.{patch}-{stage}.{devnum}",
+	"{major}.{minor}.{patch}",
+]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+tag = true
+sign_tags = true
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+
+[tool.bumpversion.parts.stage]
+optional_value = "stable"
+first_value = "stable"
+values = [
+	"alpha",
+	"beta",
+	"stable",
+]
+
+[tool.bumpversion.part.devnum]
+
+[[tool.bumpversion.files]]
+filename = "setup.py"
+search = "version=\"{current_version}\""
+replace = "version=\"{new_version}\""