Replace deprecated setuptools build-system

.gitignore

@@ -1,6 +1,13 @@
+# python cache
+__pycache__/
 *.pyc
-build/
-dist/
-*.egg-info/
-.eggs/
+
+# tool cache
 .pytest_cache/
+.mypy_cache/
+.venv/
+*.lock
+
+# build output
+dist/
+docs/_build/

README.rst

@@ -0,0 +1,57 @@
+::
+
+                       _
+                      | |
+         _ __   _   _ | |_  ___
+        | '_ \ | | | || __|/ _ \
+        | |_) || |_| || |_|  __/
+        | .__/  \__, | \__|\___|
+        | |      __/ |
+        |_|     |___/      0.8.3.dev
+
+
+What is ``pyte``?
+-----------------
+
+It's an in memory VTXXX-compatible terminal emulator.
+*XXX* stands for a series of video terminals, developed by
+`DEC <http://en.wikipedia.org/wiki/Digital_Equipment_Corporation>`_ between
+1970 and 1995. The first, and probably the most famous one, was VT100
+terminal, which is now a de-facto standard for all virtual terminal
+emulators. ``pyte`` follows the suit.
+
+So, why would one need a terminal emulator library?
+
+* To screen scrape terminal apps, for example ``htop`` or ``aptitude``.
+* To write cross platform terminal emulators; either with a graphical
+  (`xterm <http://invisible-island.net/xterm/>`_,
+  `rxvt <http://rxvt.net/>`_) or a web interface, like
+  `AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`_.
+* To have fun, hacking on the ancient, poorly documented technologies.
+
+**Note**: ``pyte`` started as a fork of `vt102 <http://github.com/samfoo/vt102>`_,
+which is an incomplete pure Python implementation of VT100 terminal.
+
+
+Installation
+------------
+
+If you have `pip <https://pip.pypa.io/en/stable>`_ you can do the usual::
+
+    pip install pyte
+
+Otherwise, download the source from `GitHub <https://github.com/selectel/pyte>`_
+and run::
+
+    python setup.py install
+
+Similar projects
+----------------
+
+``pyte`` is not alone in the weird world of terminal emulator libraries,
+here's a few other options worth checking out:
+`Termemulator <http://sourceforge.net/projects/termemulator/>`_,
+`pyqonsole <http://hg.logilab.org/pyqonsole/>`_,
+`webtty <http://code.google.com/p/webtty/>`_,
+`AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`_ and of course
+`vt102 <http://github.com/samfoo/vt102>`_.

docs/Makefile

@@ -25,7 +25,7 @@ help:
 	@echo "  htmlhelp  to make HTML files and a HTML help project"
 	@echo "  qthelp    to make HTML files and a qthelp project"
 	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdf  to make LaTeX files and run them through pdflatex"
 	@echo "  changes   to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck to check all external links for integrity"
 	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"

docs/conf.py

@@ -52,7 +52,7 @@
 # The short X.Y version.
 version = '0.8.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.3dev'
+release = '0.8.3.dev'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pyproject.toml

@@ -1,6 +1,10 @@
 [build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["flit_core"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.sdist]
+include = ["docs/*.rst", "docs/*.py", "examples/", "tests/", "AUTHORS*", "CHANGES*", "LICENSE*"]
+exclude = ["**/__pycache__/", "**/.*/", "*.lock"]
 
 [tool.mypy]
 show_error_codes = true
@@ -22,7 +26,7 @@ dev = [
 name = "pyte"
 dynamic = ["version"]
 description = "Simple VTXXX-compatible terminal emulator."
-readme = "README"
+readme = "README.rst"
 license = "LGPL-3.0-only"
 requires-python = ">=3.10"
 authors = [

pyte/__init__.py

@@ -21,6 +21,7 @@
                     see AUTHORS for details.
     :license: LGPL, see LICENSE for more details.
 """
+__version__ = "0.8.3.dev"
 
 __all__ = ("Screen", "DiffScreen", "HistoryScreen", "DebugScreen",
            "Stream", "ByteStream")