From fee4d1aa750127c83a0f4ae6871130d1a4f31499 Mon Sep 17 00:00:00 2001 From: Branch Vincent Date: Sun, 16 Nov 2025 13:02:41 -0800 Subject: [PATCH 1/2] Migrate to pyproject.toml --- .github/workflows/deploypypi.yml | 15 +- .github/workflows/unittests.yml | 8 +- .gitignore | 2 + pyproject.toml | 58 ++++++++ requirements.txt | 15 -- setup.py | 240 ------------------------------- 6 files changed, 69 insertions(+), 269 deletions(-) create mode 100644 pyproject.toml delete mode 100644 requirements.txt delete mode 100644 setup.py diff --git a/.github/workflows/deploypypi.yml b/.github/workflows/deploypypi.yml index 0209aac..78a017c 100644 --- a/.github/workflows/deploypypi.yml +++ b/.github/workflows/deploypypi.yml @@ -8,33 +8,30 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v5 + with: + fetch-depth: 0 # Fetch full history for setuptools-scm - name: Set up Python - uses: actions/setup-python@v1 + uses: actions/setup-python@v6 with: python-version: '3.10' - name: Install project dependencies run: | python -m pip install --upgrade pip - pip install -r requirements.txt + pip install -e . --group dev - name: Lint with flake8 run: | - pip install flake8 # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - name: Test with pytest run: | - pip install pytest pytest - - name: Install deploy dependencies - run: | - pip install setuptools wheel twine - name: Build and publish env: TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} run: | - python setup.py sdist bdist_wheel + python -m build twine upload dist/* diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml index dd71cbd..ad459a9 100644 --- a/.github/workflows/unittests.yml +++ b/.github/workflows/unittests.yml @@ -16,23 +16,21 @@ jobs: python-version: ['3.10', '3.11', '3.12'] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v5 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v1 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -r requirements.txt + pip install -e . --group dev - name: Lint with flake8 run: | - pip install flake8 # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - name: Test with pytest run: | - pip install pytest pytest diff --git a/.gitignore b/.gitignore index 0642a92..aeb1b20 100644 --- a/.gitignore +++ b/.gitignore @@ -103,3 +103,5 @@ venv.bak/ # mypy .mypy_cache/ /.idea + +/scalecodec/_version.py diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..575026e --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,58 @@ +[project] +name = "scalecodec" +description = "Python SCALE Codec Library" +keywords = ["scale", "codec", "polkascan", "polkadot", "substrate", "blockchain", "kusama"] +readme = "README.md" +authors = [ + { name = "Stichting Polkascan (Polkascan Foundation)", email = "info@polkascan.org" }, +] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", +] +requires-python = ">=3.6, <4" +dependencies = ["base58>=2.0.1", "more-itertools", "requests>=2.24.0"] +dynamic = ["version"] + +[project.urls] +Homepage = "https://github.com/polkascan/py-scale-codec" + +[dependency-groups] +dev = [ + "base58==2.0.1", + "atomicwrites~=1.4.0", + "attrs~=20.3.0", + "build", + "coverage==5.3", + "flake8", + "more-itertools~=8.6.0", + "pluggy==0.13.1", + "pytest>=6.1.2", + "requests>=2.24.0", + "six==1.15.0", + "twine", + "mkdocs", + "mkdocs-material", + "mkdocs-autorefs", + "mkdocstrings", + "mkdocstrings[python]", +] + +[tool.setuptools.packages.find] +include = ["scalecodec*"] + +[tool.setuptools.package-data] +"scalecodec.type_registry" = ["*.json"] + +[tool.setuptools_scm] +version_file = "scalecodec/_version.py" + +[build-system] +requires = ["setuptools>=68", "setuptools-scm>=8"] +build-backend = "setuptools.build_meta" diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index b33debd..0000000 --- a/requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -base58==2.0.1 -atomicwrites~=1.4.0 -attrs~=20.3.0 -coverage==5.3 -more-itertools~=8.6.0 -pluggy==0.13.1 -pytest>=6.1.2 -requests>=2.24.0 -six==1.15.0 - -mkdocs -mkdocs-material -mkdocs-autorefs -mkdocstrings -mkdocstrings[python] diff --git a/setup.py b/setup.py deleted file mode 100644 index e275d4c..0000000 --- a/setup.py +++ /dev/null @@ -1,240 +0,0 @@ -# Python SCALE Codec Library -# -# Copyright 2018-2020 Stichting Polkascan (Polkascan Foundation). -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""A setuptools based setup module. - -See: -https://packaging.python.org/guides/distributing-packages-using-setuptools/ -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages -from os import path, environ -# io.open is needed for projects that support Python 2.7 -# It ensures open() defaults to text mode with universal newlines, -# and accepts an argument to specify the text encoding -# Python 3 only projects can skip this import -from io import open - - -if environ.get('TRAVIS_TAG'): - version = environ['TRAVIS_TAG'].replace('v', '') -elif environ.get('CI_COMMIT_TAG'): - version = environ['CI_COMMIT_TAG'].replace('v', '') -elif environ.get('GITHUB_REF'): - - if not environ['GITHUB_REF'].startswith('refs/tags/v'): - raise ValueError('Incorrect tag format {}'.format(environ['GITHUB_REF'])) - - version = environ['GITHUB_REF'].replace('refs/tags/v', '') -else: - raise ValueError('Missing commit tag, can\'t set version') - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, 'README.md'), encoding='utf-8') as f: - long_description = f.read() - -# Arguments marked as "Required" below must be included for upload to PyPI. -# Fields marked as "Optional" may be commented out. - -setup( - # This is the name of your project. The first time you publish this - # package, this name will be registered for you. It will determine how - # users can install this project, e.g.: - # - # $ pip install sampleproject - # - # And where it will live on PyPI: https://pypi.org/project/sampleproject/ - # - # There are some restrictions on what makes a valid project name - # specification here: - # https://packaging.python.org/specifications/core-metadata/#name - name='scalecodec', # Required - - # Versions should comply with PEP 440: - # https://www.python.org/dev/peps/pep-0440/ - # - # For a discussion on single-sourcing the version across setup.py and the - # project code, see - # https://packaging.python.org/en/latest/single_source_version.html - version=version, # Required - - # This is a one-line description or tagline of what your project does. This - # corresponds to the "Summary" metadata field: - # https://packaging.python.org/specifications/core-metadata/#summary - description='Python SCALE Codec Library', # Optional - - # This is an optional longer description of your project that represents - # the body of text which users will see when they visit PyPI. - # - # Often, this is the same as your README, so you can just read it in from - # that file directly (as we have already done above) - # - # This field corresponds to the "Description" metadata field: - # https://packaging.python.org/specifications/core-metadata/#description-optional - long_description=long_description, # Optional - - # Denotes that our long_description is in Markdown; valid values are - # text/plain, text/x-rst, and text/markdown - # - # Optional if long_description is written in reStructuredText (rst) but - # required for plain-text or Markdown; if unspecified, "applications should - # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and - # fall back to text/plain if it is not valid rst" (see link below) - # - # This field corresponds to the "Description-Content-Type" metadata field: - # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional - long_description_content_type='text/markdown', # Optional (see note above) - - # This should be a valid link to your project's main homepage. - # - # This field corresponds to the "Home-Page" metadata field: - # https://packaging.python.org/specifications/core-metadata/#home-page-optional - url='https://github.com/polkascan/py-scale-codec', # Optional - - # This should be your name or the name of the organization which owns the - # project. - author='Stichting Polkascan (Polkascan Foundation)', # Optional - - # This should be a valid email address corresponding to the author listed - # above. - author_email='info@polkascan.org', # Optional - - # Classifiers help users find your project by categorizing it. - # - # For a list of valid classifiers, see https://pypi.org/classifiers/ - classifiers=[ # Optional - # How mature is this project? Common values are - # 3 - Alpha - # 4 - Beta - # 5 - Production/Stable - 'Development Status :: 5 - Production/Stable', - - # Indicate who your project is intended for - 'Intended Audience :: Developers', - - # Pick your license as you wish - 'License :: OSI Approved :: Apache Software License', - - # Specify the Python versions you support here. In particular, ensure - # that you indicate whether you support Python 2, Python 3 or both. - # These classifiers are *not* checked by 'pip install'. See instead - # 'python_requires' below. - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - ], - - # This field adds keywords for your project which will appear on the - # project page. What does your project relate to? - # - # Note that this is a string of words separated by whitespace, not a list. - keywords='scale codec polkascan polkadot substrate blockchain kusama', # Optional - - # You can just specify package directories manually here if your project is - # simple. Or you can use find_packages(). - # - # Alternatively, if you just want to distribute a single Python file, use - # the `py_modules` argument instead as follows, which will expect a file - # called `my_module.py` to exist: - # - # py_modules=["my_module"], - # - #packages=find_packages(exclude=['contrib', 'docs', 'tests', 'test']), # Required - packages=find_packages(exclude=['contrib', 'docs', 'tests', 'test']), # Required - - # Specify which Python versions you support. In contrast to the - # 'Programming Language' classifiers above, 'pip install' will check this - # and refuse to install the project if the version does not match. If you - # do not support Python 2, you can simplify this to '>=3.5' or similar, see - # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires - - #python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4', - python_requires='>=3.6, <4', - - # This field lists other packages that your project depends on to run. - # Any package you put here will be installed by pip when your project is - # installed, so they must be valid existing projects. - # - # For an analysis of "install_requires" vs pip's requirements files see: - # https://packaging.python.org/en/latest/requirements.html - install_requires=['more-itertools', 'base58>=2.0.1', 'requests>=2.24.0'], # Optional - - # List additional groups of dependencies here (e.g. development - # dependencies). Users will be able to install these using the "extras" - # syntax, for example: - # - # $ pip install sampleproject[dev] - # - # Similar to `install_requires` above, these must be valid existing - # projects. - extras_require={ # Optional - #'dev': ['check-manifest'], - 'test': ['coverage', 'pytest'], - }, - - # If there are data files included in your packages that need to be - # installed, specify them here. - # - # If using Python 2.6 or earlier, then these have to be included in - # MANIFEST.in as well. - - package_data={ # Optional - 'scalecodec.type_registry': ['*.json'], - }, - - # Although 'package_data' is the preferred approach, in some case you may - # need to place data files outside of your packages. See: - # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files - # - # In this case, 'data_file' will be installed into '/my_data' - # data_files=[('type_registry', ['scalecodec/type_registry/*.json'])], # Optional - - # To provide executable scripts, use entry points in preference to the - # "scripts" keyword. Entry points provide cross-platform support and allow - # `pip` to create the appropriate form of executable for the target - # platform. - # - # For example, the following would provide a command called `sample` which - # executes the function `main` from this package when invoked: - - # entry_points={ # Optional - # 'console_scripts': [ - # 'sample=sample:main', - # ], - # }, - - # List additional URLs that are relevant to your project as a dict. - # - # This field corresponds to the "Project-URL" metadata fields: - # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use - # - # Examples listed include a pattern for specifying where the package tracks - # issues, where the source is hosted, where to say thanks to the package - # maintainers, and where to support the project financially. The key is - # what's used to render the link text on PyPI. - # project_urls={ # Optional - # 'Bug Reports': 'https://github.com/pypa/sampleproject/issues', - # 'Funding': 'https://donate.pypi.org', - # 'Say Thanks!': 'http://saythanks.io/to/example', - # 'Source': 'https://github.com/pypa/sampleproject/', - # }, -) From e8fcf132a3476c28fd7dfec3eef19ce909b3117a Mon Sep 17 00:00:00 2001 From: Branch Vincent Date: Sun, 16 Nov 2025 13:36:37 -0800 Subject: [PATCH 2/2] Add support for python 3.14, drop <3.9 --- .github/workflows/deploypypi.yml | 3 ++- .github/workflows/unittests.yml | 3 ++- pyproject.toml | 14 ++++++++------ 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/workflows/deploypypi.yml b/.github/workflows/deploypypi.yml index 78a017c..1837646 100644 --- a/.github/workflows/deploypypi.yml +++ b/.github/workflows/deploypypi.yml @@ -14,7 +14,8 @@ jobs: - name: Set up Python uses: actions/setup-python@v6 with: - python-version: '3.10' + python-version: '3.14' + cache: pip - name: Install project dependencies run: | python -m pip install --upgrade pip diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml index ad459a9..be53491 100644 --- a/.github/workflows/unittests.yml +++ b/.github/workflows/unittests.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ['3.10', '3.11', '3.12'] + python-version: ['3.10', '3.11', '3.12', '3.13', '3.14'] steps: - uses: actions/checkout@v5 @@ -21,6 +21,7 @@ jobs: uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} + cache: pip - name: Install dependencies run: | python -m pip install --upgrade pip diff --git a/pyproject.toml b/pyproject.toml index 575026e..f7f561b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,20 +3,22 @@ name = "scalecodec" description = "Python SCALE Codec Library" keywords = ["scale", "codec", "polkascan", "polkadot", "substrate", "blockchain", "kusama"] readme = "README.md" +license = "Apache-2.0" authors = [ { name = "Stichting Polkascan (Polkascan Foundation)", email = "info@polkascan.org" }, ] classifiers = [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", ] -requires-python = ">=3.6, <4" +requires-python = ">=3.9" dependencies = ["base58>=2.0.1", "more-itertools", "requests>=2.24.0"] dynamic = ["version"] @@ -54,5 +56,5 @@ include = ["scalecodec*"] version_file = "scalecodec/_version.py" [build-system] -requires = ["setuptools>=68", "setuptools-scm>=8"] +requires = ["setuptools>=77.0.3", "setuptools-scm>=8"] build-backend = "setuptools.build_meta"