python-waterloo-lexer 0.5.2__tar.gz → 0.5.3__tar.gz

{python_waterloo_lexer-0.5.2 → python_waterloo_lexer-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-waterloo-lexer
-Version: 0.5.2
+Version: 0.5.3
 Summary: A pygments lexer derived from the Python lexer, for Waterloo docstrings
 Author: Uwe
 License: BSD-2-Clause

python_waterloo_lexer-0.5.3/README.md

@@ -0,0 +1,62 @@
+# Python-Waterloo Lexer
+
+![Status](https://img.shields.io/badge/status-pre--release-orange)
+![Version](https://img.shields.io/badge/version-0.5.3-blue)
+![License](https://img.shields.io/badge/license-BSD--2--Clause-blue)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+
+`python-waterloo-lexer` is a Pygments lexer for Python files that contain
+Waterloo docstrings.
+
+It can be used with `pygmentize` and other tools that load Pygments lexers via
+entry points.
+
+## What it provides
+
+- a `python-waterloo` Pygments lexer alias
+- syntax highlighting for Python files with Waterloo docstrings
+- installation via PyPI, local checkout, or Git URL
+
+## Installation
+
+```bash
+pip install python-waterloo-lexer
+```
+
+## Quick test
+
+After installation, the lexer is available under the alias
+`python-waterloo`.
+
+```bash
+pygmentize -l python-waterloo -f terminal16m <file.py>
+```
+
+You can also check whether Pygments lists the lexer:
+
+```bash
+pygmentize -L lexers | grep -i waterloo || true
+```
+
+## Terminal viewer
+
+For a quick terminal preview, a `less` alias can be handy:
+
+```bash
+alias lessh='LESSOPEN="| pygmentize -O style=monokai %s" less -M -R'
+```
+
+Then open files with:
+
+```bash
+lessh <file.py>
+```
+
+## Project repository
+
+Development happens in the Waterloo repository:
+
+- <https://github.com/uwe-at-sdv/sdv_doc_waterloo>
+
+The repository also contains related tooling, documentation, and editor
+integrations for Waterloo docstrings.

{python_waterloo_lexer-0.5.2 → python_waterloo_lexer-0.5.3}/python_waterloo_lexer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-waterloo-lexer
-Version: 0.5.2
+Version: 0.5.3
 Summary: A pygments lexer derived from the Python lexer, for Waterloo docstrings
 Author: Uwe
 License: BSD-2-Clause

{python_waterloo_lexer-0.5.2 → python_waterloo_lexer-0.5.3}/python_waterloo_lexer.py

@@ -41,7 +41,7 @@ from pygments.token import Error, Generic, Keyword, Name, String, Literal, Numbe
 
 #----- Changelog ----------------------------------------------#
 
-__version__ = "0.5.2"
+__version__ = "0.5.3"
 
 #----- Constants ----------------------------------------------#
 RE_SECTION = re.compile(

python_waterloo_lexer-0.5.2/README.md

@@ -1,114 +0,0 @@
-# Python-Waterloo Lexer (Pygments)
-
-This folder contains a custom Pygments lexer for Python files with Waterloo docstrings.
-
-> **Branch note (`ide-plugins`)**
->
-> The Pygments lexer package lives on the `ide-plugins` branch. Installation from Git must
-> reference `@ide-plugins` (see below). General repository documentation is in `@main/README.md`.
-
-## Prerequisites
-
-- Python >= 3.10
-- `pip`
-- `pygmentize` (provided by the `Pygments` package)
-
-## Clone the correct branch
-
-The plugin sources live on branch `ide-plugins`. If you want to work from a
-fresh checkout, clone that branch explicitly:
-
-HTTPS:
-```bash
-git clone --branch ide-plugins --single-branch https://github.com/uwe-at-sdv/sdv_doc_waterloo.git
-cd sdv_doc_waterloo
-```
-SSH:
-```bash
-git clone --branch ide-plugins --single-branch git+ssh://git@github.com/uwe-at-sdv/sdv_doc_waterloo.git
-cd sdv_doc_waterloo
-```
-
-## Quick test (no install)
-
-Run `pygmentize` directly against the lexer source file (no packaging/install needed):
-
-Dark terminal theme:
-```bash
-pygmentize -x \
-  -l pygments/python_waterloo_lexer.py:PythonWaterlooLexer -f terminal16m -O style=monokai \
-  examples-python/example_function_full.py
-```
-Light terminal theme:
-```bash
-pygmentize -x \
-  -l pygments/python_waterloo_lexer.py:PythonWaterlooLexer -f terminal16m -O style=friendly \
-  examples-python/example_function_full.py
-```
-
-## Terminal viewer
-
-For ad-hoc file viewing in a terminal, a simple `less` alias can be useful:
-
-```bash
-alias lessh='LESSOPEN="| pygmentize -O style=monokai %s" less -M -R'
-```
-
-Then use:
-
-```bash
-lessh examples-python/example_function_full.py
-```
-
-If your system already provides `lesspipe`, you can also wire that into your
-shell startup file and have `less` itself perform the preprocessing step.
-
-## Install from a local checkout
-
-If you have cloned the repository, install the lexer package from this folder:
-
-```bash
-pip install ./pygments
-```
-
-For development, an editable install can be convenient:
-
-```bash
-pip install -e ./pygments
-```
-
-### Sanity check (after install)
-
-The lexer should be discoverable by its alias:
-
-```bash
-pygmentize -l python-waterloo -f terminal16m examples-python/example_function_full.py
-```
-
-Tip: You can also check whether Pygments lists the lexer:
-
-```bash
-pygmentize -L lexers | grep -i waterloo || true
-```
-
-## Install from PyPI (once available)
-
-```bash
-pip install python-waterloo-lexer
-```
-
-## Install directly from Git
-
-If the repository is reachable by `pip`, the package can also be installed
-directly from a Git URL.
-
-**Important:** The `@ide-plugins` ref is required because this package is maintained on that branch.
-
-HTTPS:
-```bash
-pip install "git+https://github.com/uwe-at-sdv/sdv_doc_waterloo.git@ide-plugins#subdirectory=pygments"
-```
-SSH:
-```bash
-pip install "git+ssh://git@github.com/uwe-at-sdv/sdv_doc_waterloo.git@ide-plugins#subdirectory=pygments"
-```