Reorganization. Added makefile

CHANGES

@@ -6,6 +6,13 @@ maintained as a mature library.  No new major features are planned, but
 issues reported for bugs are still welcome. Any changes to the 
 software will be noted here.
 
+Version 2022.10.27
+------------------
+10/27/22  Reoganization/modernization of the build process. PLY continues
+          to make no package-installable releases.  However, you can now
+	  use the Makefile to build artifacts installable via pip.
+	  Use `make test` to test and `make build` to build.
+
 Version 2022_01_02
 ------------------
 12/12/21  PLY is no longer being developed in public.  Instead

MANIFEST.in

@@ -0,0 +1,4 @@
+include Makefile CONTRIBUTING.md
+recursive-include example *
+recursive-include tests *
+recursive-include docs *

Makefile

@@ -0,0 +1,26 @@
+PYTHON=python3
+VENV=.venv
+
+# Setup and install all of the required tools for building, testing,
+# and deploying
+setup::
+	rm -rf $(VENV)
+	$(PYTHON) -m venv $(VENV)
+	./$(VENV)/bin/python -m pip install pytest
+	./$(VENV)/bin/python -m pip install pytest-cov
+	./$(VENV)/bin/python -m pip install build
+	./$(VENV)/bin/python -m pip install twine
+
+# Run unit tests
+test::
+	./$(VENV)/bin/python -m pip install .
+	./$(VENV)/bin/python tests/testlex.py
+	./$(VENV)/bin/python tests/testyacc.py
+
+# Build an artifact suitable for installing with pip
+build::
+	./$(VENV)/bin/python -m build
+
+# Install into the default Python
+install::
+	$(PYTHON) -m pip install .

README.md

@@ -18,22 +18,17 @@ flexibility in terms of how you decide to use it.  You can use PLY to
 build Abstract Syntax Trees (ASTs), simple one-pass compilers,
 protocol decoders, or even a more advanced parsing framework.
 
-## Important Notice - October 11, 2022
+## Important Notice - October 27, 2022
 
-I'm officially retiring the PLY project.  There will be no further
-releases.  Should you choose to still use it, the GitHub repo will
-remain alive--feel free to vendor the code and report bugs as you see
-fit.  I'd like to thank everyone who contributed to the
-project over the last twenty-one years. -- Dave
+The PLY project will make no further package-installable releases.
+If you want the latest version, you'll need to download it here
+or clone the repo.
 
-## Download
-
-* [Current Release (ply-2022_01_02)](https://github.com/dabeaz/ply/raw/master/ply-2022_01_02.tar.gz)
-* [Historial Releases](https://github.com/dabeaz/archive/tree/main/ply)
+## Requirements
 
 The current release of PLY requires the use of Python 3.6 or
 greater. If you need to support an older version, download one of the
-historical releases.
+historical releases at https://github.com/dabeaz/archive/tree/main/ply.
 
 ## How to Install and Use 
 

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,18 @@
+[metadata]
+name = ply
+version = 2022.10.27
+url = https://github.com/dabeaz/ply
+author = David Beazley
+author_email = "David Beazley" <[email protected]>
+description = "PLY - Sly Lex Yacc"
+long_description = "PLY is an implementation of lex and yacc. No longer maintained on PyPI. Latest version on GitHub."
+license = MIT
+license_files = LICENSE
+classifiers =
+    License :: OSI Approved :: MIT License
+
+[options]
+package_dir =
+    =src
+
+packages = ply

ply/__init__.py → src/ply/__init__.py

@@ -2,4 +2,4 @@
 # Author: David Beazley ([email protected])
 # https://github.com/dabeaz/ply
 
-__version__ = '2022_01_02'
+__version__ = '2022.10.27'

test/calclex.py → tests/calclex.py

@@ -1,9 +1,6 @@
 # -----------------------------------------------------------------------------
 # calclex.py
 # -----------------------------------------------------------------------------
-import sys
-
-if ".." not in sys.path: sys.path.insert(0,"..")
 import ply.lex as lex
 
 tokens = (

test/lex_closure.py → tests/lex_closure.py

@@ -1,9 +1,6 @@
 # -----------------------------------------------------------------------------
 # lex_closure.py
 # -----------------------------------------------------------------------------
-import sys
-
-if ".." not in sys.path: sys.path.insert(0,"..")
 import ply.lex as lex
 
 tokens = (

test/lex_doc1.py → tests/lex_doc1.py

@@ -2,9 +2,6 @@
 #
 # Missing documentation string
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_dup1.py → tests/lex_dup1.py

@@ -2,9 +2,6 @@
 #
 # Duplicated rule specifiers
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_dup2.py → tests/lex_dup2.py

@@ -2,9 +2,6 @@
 #
 # Duplicated rule specifiers
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_dup3.py → tests/lex_dup3.py

@@ -2,9 +2,6 @@
 #
 # Duplicated rule specifiers
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_empty.py → tests/lex_empty.py

@@ -2,9 +2,6 @@
 #
 # No rules defined
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_error1.py → tests/lex_error1.py

@@ -2,9 +2,6 @@
 #
 # Missing t_error() rule
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_error2.py → tests/lex_error2.py

@@ -2,9 +2,6 @@
 #
 # t_error defined, but not function
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_error3.py → tests/lex_error3.py

@@ -2,9 +2,6 @@
 #
 # t_error defined as function, but with wrong # args
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_error4.py → tests/lex_error4.py

@@ -2,9 +2,6 @@
 #
 # t_error defined as function, but too many args
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_hedit.py → tests/lex_hedit.py

@@ -13,8 +13,6 @@
 # This example shows how to modify the state of the lexer to parse
 # such tokens
 # -----------------------------------------------------------------------------
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
 
 import ply.lex as lex
 

test/lex_ignore.py → tests/lex_ignore.py

@@ -2,9 +2,6 @@
 #
 # Improperly specific ignore declaration
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [

test/lex_ignore2.py → tests/lex_ignore2.py

@@ -2,9 +2,6 @@
 #
 # ignore declaration as a raw string
 
-import sys
-if ".." not in sys.path: sys.path.insert(0,"..")
-
 import ply.lex as lex
 
 tokens = [