Packaging

Author: rocky

README.rst

@@ -5,13 +5,13 @@ xasm
 
 *NOTE: this is in beta*
 
-A Cross-Python bytecode Assembler
+A cross-version Python bytecode assembler
 
 
 Introduction
 ------------
 
-The Python `xasm` module has routines for assembly, and has a command to
+The Python ``xasm`` module has routines for assembly, and has a command to
 assemble bytecode for several different versions of Python.
 
 Here are some potential uses:
@@ -23,10 +23,10 @@ Here are some potential uses:
 * Foil decompilers like uncompyle6_ so that they can’t disassemble bytecode (at least for now)
 
 This support the same kinds of bytecode that xdis_ supports. This is
-pretty much all released bytecode, although we tend to lag behind the
+pretty much all released bytecode before Python 3.11. We tend to lag behind the
 latest Python releases.
 
-The code requires Python 2.7 or later.
+The code requires Python 3.6 or later.
 
 Assembly files
 --------------
@@ -47,17 +47,30 @@ See how-to-use_ for more detail. Some general some principles:
 Installation
 ------------
 
-The standard Python routine:
+*If you are using Python 3.11 or later*, you can install from PyPI using the name ``xasm``::
 
-::
-
-    pip install -e .
-    pip install -r requirements-dev.txt
+    pip install xasm
 
-A GNU makefile is also provided so :code:`make install` (possibly as root or
+A GNU makefile is also provided so ``make install`` (possibly as root or
 sudo) will do the steps above.
 
 
+*If you are using Python before 3.11*, do not install using PyPI, but instead install using a file in the [GitHub Releases section](https://github.com/rocky/python-xasm/releases). Older Python used to use `easy_install <https://python101.pythonlibrary.org/chapter29_pip.html#using-easy-install>`_. But this is no longer supported in PyPi or newer Python versions. And vice versa, *poetry* nor *pip*, (the newer ways) are not supported on older Pythons.
+
+If the Python version you are running xasm is between Python 3.6 through 3.11, use a tarball called xasm_36-*x.y.z*.tar.gz.
+
+If the Python version you are running xasm is 3.11 or later, use a file called xasm-*x.y.z*.tar.gz.
+
+Similarly, a tarball with or without the underscore *xx*,  e.g., xasm_36-*x.y.z*.tar.gz. works only from Python 3.11 or greater.
+
+Rationale for using Git Branches
+++++++++++++++++++++++++++++++++
+
+It is currently impossible (if not impractical) to have one Python source code of this complexity and with this many features that can run both Python 3.6 and Python 3.13+. The languages have drifted so much, and packaging is vastly different.
+
+A GNU makefile is also provided so :code:`make install` (possibly as root or sudo) will do the steps above.
+
+
 Testing
 -------
 
@@ -137,8 +150,8 @@ Here is an assembly for the above:
                 RETURN_VALUE
 
 
-The above can be created automatically from Python source code using the `pydisasm`
-command from `xdis`:
+The above can be created automatically from Python source code using the ``pydisasm``
+command from ``xdis``:
 
 ::
 

admin-tools/make-dist-newest.sh

@@ -1,20 +1,20 @@
 #!/bin/bash
 # The name Python's import uses.
 # It is reflected in the directory structure.
-PACKAGE_MODULE="python_control_flow"
+PACKAGE_MODULE="xasm"
 
 # The name that PyPi sees this as.
 # It is set in setup.py's name.
-PACKAGE_NAME="python-control-flow"
+PACKAGE_NAME="xasm"
 
 # FIXME put some of the below in a common routine
 function finish {
-  if [[ -n "$make_dist_python_control_flow_owd" ]] then
-     cd $make_dist_python_control_flow_newest_owd
+  if [[ -n "$make_dist_xasm_owd" ]] then
+     cd $make_dist_xasm_newest_owd
   fi
 }
 
-make_dist_python_control_flow_newest_owd=$(pwd)
+make_dist_xasm_newest_owd=$(pwd)
 cd $(dirname ${BASH_SOURCE[0]})
 trap finish EXIT
 

pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = [
+    "setuptools",
+]
+
+build-backend = "setuptools.build_meta"
+
+[project]
+authors = [
+    {name = "Rocky Bernstein",	email = "rb@dustyfeet.com"},
+]
+
+name = "xasm"
+description = "Cross-version Python bytecode assembler"
+dependencies = [
+    "click",
+    "xdis >= 6.1.1, < 6.3.0",
+]
+readme = "README.rst"
+license = "GPL-2.0"
+keywords = ["Python bytecode", "bytecode", "disassembler"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "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",
+    "Topic :: Software Development :: Code Generators",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/rocky/python-xasm"
+Downloads = "https://github.com/rocky/python-xasm/releases"
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "black",
+    "isort",
+    "pytest",
+]
+
+[project.scripts]
+python-cfg = "xasm.__main__:main"
+
+[tool.setuptools]
+packages = [
+    "xasm",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "xasm.version.__version__"}
+
+[tool.pyright]
+include = ["xasm"]
+# exclude = []
+ignore = ["dist", "docs", "tmp", ".cache"]

setup.py

@@ -2,31 +2,6 @@
 
 """Setup script for the 'xasm' distribution."""
 
-from setuptools import find_packages, setup
+from setuptools import setup
 
-from __pkginfo__ import (__version__, author, author_email, classifiers,
-                         install_requires, license, long_description, modname,
-                         py_modules, short_desc, tests_require, web, zip_safe)
-
-setup(
-    author=author,
-    author_email=author_email,
-    classifiers=classifiers,
-    description=short_desc,
-    license=license,
-    long_description=long_description,
-    long_description_content_type="text/x-rst",
-    name=modname,
-    packages=find_packages(),
-    py_modules=py_modules,
-    install_requires=install_requires,
-    entry_points="""
-        [console_scripts]
-        pyc-xasm    = xasm.xasm_cli:main
-        pyc-convert = xasm.pyc_convert:main
-       """,
-    tests_require=tests_require,
-    url=web,
-    version=__version__,
-    zip_safe=zip_safe,
-)
+setup()