Merge pull request #50 from pacrob/upgrade-template

Upgrade template

Author: pacrob

.circleci/config.yml

@@ -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,54 @@ 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
   test:
-    jobs:
-      - docs
-      - py38-core
-      - py39-core
-      - py310-core
-      - py311-core
-      - py312-core
-      - py38-lint
-      - py39-lint
-      - py310-lint
-      - py311-lint
-      - py312-lint
-      - py38-wheel
-      - py39-wheel
-      - py310-wheel
-      - py311-wheel
-      - py312-wheel
-      - py311-windows-wheel
-      - py312-windows-wheel
+    jobs: *all_jobs
+  nightly:
+    triggers:
+      - schedule:
+          # Weekdays 12:00p UTC
+          cron: "0 12 * * 1,2,3,4,5"
+          filters:
+            branches:
+              only:
+                - main
+    jobs: *all_jobs

.gitignore

@@ -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

.readthedocs.yaml

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

LICENSE

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

MANIFEST.in

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

Makefile

@@ -6,15 +6,19 @@ 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 "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 {} +
@@ -24,14 +28,18 @@ clean-pyc:
 
 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
 
 # docs commands
 
@@ -41,6 +49,9 @@ docs: check-docs
 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:
@@ -55,8 +66,6 @@ build-docs:
 	$(MAKE) -C docs html
 	$(MAKE) -C docs doctest
 
-# docs helpers for CI, which requires extra dependencies
-
 check-docs-ci: build-docs build-docs-ci validate-newsfragments
 
 build-docs-ci:

README.md

@@ -12,30 +12,8 @@ Read the [documentation](https://hexbytes.readthedocs.io/).
 
 View the [change log](https://hexbytes.readthedocs.io/en/latest/release_notes.html).
 
-## Quickstart
+## Installation
 
 ```sh
 python -m pip install hexbytes
 ```
-
-```py
-# convert from bytes to a prettier representation at the console
->>> HexBytes(b"\x03\x08wf\xbfh\xe7\x86q\xd1\xeaCj\xe0\x87\xdat\xa1'a\xda\xc0 \x01\x1a\x9e\xdd\xc4\x90\x0b\xf1;")
-HexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')
-
-# HexBytes accepts the hex string representation as well, ignoring case and 0x prefixes
->>> hb = HexBytes('03087766BF68E78671D1EA436AE087DA74A12761DAC020011A9EDDC4900BF13B')
-HexBytes('0x03087766bf68e78671d1ea436ae087da74a12761dac020011a9eddc4900bf13b')
-
-# get the first byte:
->>> hb[0]
-3
-
-# show how many bytes are in the value
->>> len(hb)
-32
-
-# cast back to the basic `bytes` type
->>> bytes(hb)
-b"\x03\x08wf\xbfh\xe7\x86q\xd1\xeaCj\xe0\x87\xdat\xa1'a\xda\xc0 \x01\x1a\x9e\xdd\xc4\x90\x0b\xf1;"
-```

docs/code_of_conduct.rst

@@ -5,7 +5,7 @@ Our Pledge
 ~~~~~~~~~~
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, gender identity and expression, level of experience,
 education, socio-economic status, nationality, personal appearance, race,

docs/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # HexBytes documentation build configuration file, created by
 # sphinx-quickstart on Thu Oct 16 20:43:24 2014.
 #
@@ -19,7 +17,7 @@
 
 import os
 
-DIR = os.path.dirname("__file__")
+DIR = os.path.dirname(__file__)
 with open(os.path.join(DIR, "../setup.py"), "r") as f:
     for line in f:
         if "version=" in line:
@@ -195,14 +193,16 @@
 
 # -- Options for LaTeX output ---------------------------------------------
 
-# latex_elements = {
-#   # The paper size ('letterpaper' or 'a4paper').
-#   'papersize': 'letterpaper',
-#   # The font size ('10pt', '11pt' or '12pt').
-#   'pointsize': '10pt',
-#   # Additional stuff for the LaTeX preamble.
-#   'preamble': '',
-# }
+latex_engine = "xelatex"
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
+}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,

docs/contributing.rst

@@ -15,7 +15,6 @@ development machine:
 
     git clone git@github.com:your-github-username/hexbytes.git
 
-
 Next, install the development dependencies. We recommend using a virtual environment,
 such as `virtualenv <https://virtualenv.pypa.io/en/stable/>`_.
 
@@ -38,7 +37,6 @@ We can run all tests with:
 
     pytest tests
 
-
 Code Style
 ~~~~~~~~~~
 
@@ -50,7 +48,6 @@ manually with:
 
     make lint
 
-
 If you need to make a commit that skips the ``pre-commit`` checks, you can do so with
 ``git commit --no-verify``.
 
@@ -74,7 +71,7 @@ a discussion, and doesn't necessarily need to be the final, finished submission.
 GitHub's documentation for working on pull requests is
 `available here <https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`_.
 
-Once you've made a pull request take a look at the Circle CI build status in the
+Once you've made a pull request, take a look at the Circle CI build status in the
 GitHub interface and make sure all tests are passing. In general pull requests that
 do not pass the CI build yet won't get reviewed unless explicitly requested.
 
@@ -100,10 +97,8 @@ Before releasing a new version, build and test the package that will be released
 .. code:: sh
 
     git checkout main && git pull
-
     make package-test
 
-
 This will build the package and install it in a temporary virtual environment. Follow
 the instructions to activate the venv and test whatever you think is important.
 
@@ -113,7 +108,6 @@ You can also preview the release notes:
 
     towncrier --draft
 
-
 Build the release notes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -136,7 +130,6 @@ After confirming that the release package looks okay, release a new version:
 
     make release bump=$$VERSION_PART_TO_BUMP$$
 
-
 This command will:
 
 - Bump the version number as specified in ``.pyproject.toml`` and ``setup.py``.