Merge pull request #20 from branchv/pyproject

#8 Migrate to pyproject.toml and uv

Author: roskakori

.classpath

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - name: Lint
+        uses: pre-commit/action@v3.0.1
+      - run: ant test

.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.6
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: no-commit-to-branch
+        args: [--branch, master]

.landscape.yaml

@@ -0,0 +1,38 @@
+## Developer cheat sheet
+
+Bump version number:
+
+1. Possibly update copyright year in:
+
+   - `ebcdic/__init__.py`
+   - `LICENSE.txt` and
+   - `README.rst`
+
+2. Edit `ebcdic/_version.py:__version__`.
+3. Describe changes in `README.rst`.
+
+Upload release to PyPI::
+
+```console
+$ git checkout master
+$ git pull
+$ ant test
+$ cd ebcdic
+$ uv build
+$ uv publish
+```
+
+Update production branch::
+
+```console
+$ git checkout production
+$ git merge master
+$ git push
+```
+
+Tag a release::
+
+```console
+$ git tag -a -m "Tagged version 1.x.x." v1.x.x
+$ git push --tags
+```

.pre-commit-config.yaml

@@ -1,23 +1,18 @@
-CodecMapper
-===========
+# CodecMapper
 
 CodecMapper derives mapping files from Java Charsets which can be processed
 by Python's gencodec.py.
 
-
-Requirements
-------------
+## Requirements
 
 To build and run CodecMapper, you need:
 
-  1. Java 1.7 or later
-  2. ant 1.8 or later, available from https://ant.apache.org/.
+1. Java 1.7 or later
+2. ant 1.8 or later, available from https://ant.apache.org/.
 
 It might also work with earlier versions of ant but this has not been tested.
 
-
-Usage
------
+## Usage
 
 To build CodecMapper, run:
 
@@ -35,42 +30,29 @@ The resulting mapping file is stored in `iso-8859-15.txt`. The generated mapping
 are located in the same folder and have names like
 `iso-8859.15.mapping`.
 
-
-EBCDIC codecs for Python
-------------------------
+## EBCDIC codecs for Python
 
 As an example usage, CodecMapper can provide additional EBCDIC codecs for
 Python, which can easily be packaged and distributed.
 
-To test the Python codecs you need to setup a Pythen venv:
-
-```sh
-$ python -m venv venv
-$ source venv/bin/activate
-$ pip install --upgrade pip
-$ pip install pycodestyle wheel
-```
-
+To test the Python codecs, first install [uv](https://docs.astral.sh/uv/getting-started/installation/).
 After that you can build the Python codecs and run the tests:
 
 ```sh
 $ ant test
 ```
+
 For more information, browse the "ebcdic" folder of this distribution and
 take a look at the README.rst.
 
-
-Source code
------------
+## Source code
 
 See https://github.com/roskakori/CodecMapper.
 
-
-License
--------
+## License
 
 Copyright (c) 2013 - 2019, Thomas Aglassinger
 All rights reserved.
 
 Distributed under the BSD license, see [LICENSE.txt](LICENSE.txt) for more
-information.
+information.

.project

@@ -2,7 +2,6 @@
     <description>
         Build CodecMapper and additional codecs for Python.
     </description>
-    <property name="python" value="${basedir}/venv/bin/python"/>
     <property name="source" location="source"/>
     <property name="build" location="build"/>
     <property name="dist" location="dist"/>
@@ -34,10 +33,6 @@
             <fileset dir="ebcdic/ebcdic" includes="cp*.*" excludes="cp*ms.py"/>
         </delete>
         <delete dir="ebcdic/ebcdic/temp" includeemptydirs="true" quiet="true"/>
-        <exec executable="${python}" dir="ebcdic" failonerror="true">
-            <arg path="ebcdic/setup.py"/>
-            <arg value="clean"/>
-        </exec>
     </target>
 
     <target name="ebcdic" description="build ebcdic package for Python" depends="dist">
@@ -96,20 +91,20 @@
             <!-- <arg value="cp4971" /> --><!-- Unavailable: Greece -->
             <!-- <arg value="cp9067" /> --><!-- Unavailable: Greece -->
         </java>
-        <exec executable="${python}" dir="ebcdic/ebcdic" failonerror="true">
+        <exec executable="uv" dir="ebcdic/ebcdic" failonerror="true">
+            <arg value="run"/>
             <arg value="${basedir}/tools/gencodec.py"/>
             <arg value="temp"/>
         </exec>
         <delete includeemptydirs="true">
             <fileset dir="ebcdic/ebcdic" includes="*.mapping, temp"/>
             <fileset dir="ebcdic/ebcdic/temp"/>
         </delete>
-        <exec executable="${python}" dir="ebcdic" failonerror="true">
-            <arg path="ebcdic/setup.py"/>
-            <arg value="sdist"/>
-            <arg value="--dist-dir"/>
+        <exec executable="uv" dir="ebcdic" failonerror="true">
+            <arg value="build"/>
+            <arg value="--out-dir"/>
             <arg path="${dist}"/>
-            <arg value="--formats=zip"/>
+            <arg value="--sdist"/>
         </exec>
     </target>
 
@@ -119,22 +114,18 @@
         </java>
     </target>
 
-    <target name="pep8" description="validate Python code style">
-        <exec executable="pycodestyle" failonerror="true">
-            <arg path="ebcdic/setup.py"/>
-            <arg value="--config"/>
-            <arg path="ebcdic/setup.cfg"/>
-            <arg value="--max-line-length=120"/>
-            <arg path="ebcdic/setup.py"/>
-            <arg path="ebcdic/ebcdic/__init__.py"/>
-            <arg path="ebcdic/ebcdic/test/test_ebcdic.py"/>
+    <target name="lint" description="validate Python code style">
+        <exec executable="uv" dir="ebcdic" failonerror="true">
+            <arg value="run"/>
+            <arg value="ruff"/>
+            <arg value="check"/>
         </exec>
     </target>
 
-    <target name="test" description="run test suite" depends="ebcdic, pep8">
-        <exec executable="${python}" dir="ebcdic" failonerror="true">
-            <arg path="ebcdic/setup.py"/>
-            <arg value="test"/>
+    <target name="test" description="run test suite" depends="ebcdic, lint">
+        <exec executable="uv" dir="ebcdic" failonerror="true">
+            <arg value="run"/>
+            <arg value="pytest"/>
         </exec>
     </target>
 </project>

CONTRIBUTING.md

@@ -140,7 +140,7 @@ Then run::
 
 to build and test the distribution.
 
-The ``ebcdic/setup.py`` automatically includes the new encoding in the package
+The ``ebcdic/pyproject.toml`` automatically includes the new encoding in the package
 and ``ebcdic/__init__.py`` registers it during ``import ebcdic``, so no
 further steps are needed.
 

README.md

@@ -27,19 +27,18 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-from __future__ import absolute_import
+
 import codecs
 
+from ._version import __version__, __version_info__
 
 __all__ = [
-    'codec_names',
-    'ignored_codec_names',
-    'lookup',
-    '__version__',
-    '__version_info__'
+    "codec_names",
+    "ignored_codec_names",
+    "lookup",
+    "__version__",
+    "__version_info__",
 ]
-__version_info__ = (1, 1, 1)
-__version__ = '.'.join([str(item) for item in __version_info__])
 
 
 def _codec_names():
@@ -50,15 +49,15 @@ def _codec_names():
     import os.path
 
     package_folder = os.path.dirname(__file__)
-    for codec_path in glob.glob(os.path.join(package_folder, 'cp*.py')):
+    for codec_path in glob.glob(os.path.join(package_folder, "cp*.py")):
         codec_name = os.path.splitext(os.path.basename(codec_path))[0]
         yield codec_name
 
 
 def _create_codec_name_to_info_map():
     result = {}
     for codec_name in codec_names:
-        codec_module = __import__('ebcdic.' + codec_name, globals(), locals(), ['getregentry'])
+        codec_module = __import__("ebcdic." + codec_name, globals(), locals(), ["getregentry"])
         result[codec_name] = codec_module.getregentry()
     return result
 
@@ -76,9 +75,10 @@ def ignored_codec_names():
     A list of codec names in this package that are ignored because they are
     already provided by other means, e.g. the standard library.
     """
-    return [codec_name
-            for codec_name, codec_info in sorted(_codec_name_to_info_map.items())
-            if codec_info != codecs.lookup(codec_name)
+    return [
+        codec_name
+        for codec_name, codec_info in sorted(_codec_name_to_info_map.items())
+        if codec_info != codecs.lookup(codec_name)
     ]
 
 
@@ -89,7 +89,7 @@ def lookup(codec_name):
     """
     result = _find_ebcdic_codec(codec_name)
     if result is None:
-        raise LookupError('EBCDIC codec is %r but must be one of: %s' % (codec_name, codec_names))
+        raise LookupError(f"EBCDIC codec is {codec_name!r} but must be one of: {codec_names}")
     return result