Add a public API

.github/workflows/publish.yml

@@ -2,12 +2,14 @@ name: Publish packages to PyPI
 
 on:
   create:
-    tags: "*"
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+[a-b][0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
 
 jobs:
   publish:
     runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/')
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python

.github/workflows/test.yml

@@ -39,15 +39,22 @@ jobs:
       with:
         path: ~/.cache/pip
         key: pip-test-${{ matrix.python-version }}-${{ matrix.os }}
-    - name: Install the project
-      run: "pip install --no-binary=:all: ."
-    - name: Install test dependencies
-      run: pip install .[test] coverage[toml]
+    - name: Install the project and its test dependencies
+      run: pip install --no-binary=setuptools,wheel .[test] coverage[toml]
     - name: Test with pytest
       run: |
-        coverage run -m pytest -W always
-        coverage xml
+        python -m coverage run -m pytest -W always
+        python -m coverage xml
     - name: Send coverage data to Codecov
       uses: codecov/codecov-action@v3
       with:
         file: coverage.xml
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install the project and its Mypy dependencies
+      run: pip install --no-binary=setuptools,wheel .[types]
+    - name: Test with Mypy
+      run: mypy

docs/news.rst

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+**UNRELEASED**
+
+- Added a public API
+- Dropped support for converting ``bdist_wininst`` based installers into wheels
+
 **0.38.2 (2022-11-05)**
 
 - Fixed regression introduced in v0.38.1 which broke parsing of wheel file names with

docs/reference/wheel_convert.rst

@@ -12,14 +12,15 @@ Usage
 Description
 -----------
 
-Convert one or more eggs (``.egg``; made with ``bdist_egg``) or Windows
-installers (``.exe``; made with ``bdist_wininst``) into wheels.
+Convert one or more eggs (``.egg``; made with ``bdist_egg``) into wheels.
 
 Egg names must match the standard format:
 
 * ``<project>-<version>-pyX.Y`` for pure Python wheels
 * ``<project>-<version>-pyX.Y-<arch>`` for binary wheels
 
+Each argument can be either an ``.egg`` file, an unpacked egg directory or a directory
+containing eggs (packed or unpacked).
 
 Options
 -------

setup.cfg

@@ -32,21 +32,25 @@ package_dir=
     = src
 packages = find:
 python_requires = >=3.7
-setup_requires = setuptools >= 45.2.0
 zip_safe = False
 
 [options.packages.find]
 where = src
 
 [options.extras_require]
 test =
-    pytest >= 3.0.0
+    pytest >= 6.2.0
+    setuptools >= 57
+types =
+    mypy >= 0.982
+    pytest >= 6.2
+    types-setuptools >= 65.5.0.2
 
 [options.entry_points]
 console_scripts =
-    wheel = wheel.cli:main
+    wheel = wheel._cli:main
 distutils.commands =
-    bdist_wheel = wheel.bdist_wheel:bdist_wheel
+    bdist_wheel = wheel._bdist_wheel:bdist_wheel
 
 [tool:isort]
 src_paths = src
@@ -58,10 +62,19 @@ max-line-length = 88
 
 [tool:pytest]
 testpaths = tests
+addopts = --tb=short
 
 [coverage:run]
 source = wheel
 omit = */vendored/*
 
 [coverage:report]
 show_missing = true
+
+[mypy]
+files = src,tests
+python_version = 3.7
+exclude = testdata/
+
+[mypy-wheel.vendored.*]
+ignore_errors = True

src/wheel/__init__.py

@@ -1,3 +1,6 @@
 from __future__ import annotations
 
-__version__ = "0.38.2"
+__all__ = ["WheelError", "WheelReader", "WheelWriter", "make_filename"]
+__version__ = "1.0.0a1"
+
+from ._wheelfile import WheelError, WheelReader, WheelWriter, make_filename

src/wheel/__main__.py

@@ -5,19 +5,20 @@
 from __future__ import annotations
 
 import sys
+from typing import NoReturn
 
 
-def main():  # needed for console script
+def main() -> NoReturn:  # needed for console script
     if __package__ == "":
         # To be able to run 'python wheel-0.9.whl/wheel':
         import os.path
 
         path = os.path.dirname(os.path.dirname(__file__))
         sys.path[0:0] = [path]
-    import wheel.cli
+    import wheel._cli
 
-    sys.exit(wheel.cli.main())
+    sys.exit(wheel._cli.main())
 
 
 if __name__ == "__main__":
-    sys.exit(main())
+    main()