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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python-waterloo-lexer
3
- Version: 0.5.3
3
+ Version: 0.5.5
4
4
  Summary: A pygments lexer derived from the Python lexer, for Waterloo docstrings
5
5
  Author: Uwe
6
6
  License: BSD-2-Clause
@@ -17,7 +17,7 @@ Requires-Dist: pygments
17
17
  # Python-Waterloo Lexer
18
18
 
19
19
  ![Status](https://img.shields.io/badge/status-pre--release-orange)
20
- ![Version](https://img.shields.io/badge/version-_VERSION_-blue)
20
+ ![Version](https://img.shields.io/badge/version-0.5.5-blue)
21
21
  ![License](https://img.shields.io/badge/license-BSD--2--Clause-blue)
22
22
  ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
23
23
 
@@ -1,7 +1,7 @@
1
1
  # Python-Waterloo Lexer
2
2
 
3
3
  ![Status](https://img.shields.io/badge/status-pre--release-orange)
4
- ![Version](https://img.shields.io/badge/version-0.5.3-blue)
4
+ ![Version](https://img.shields.io/badge/version-0.5.5-blue)
5
5
  ![License](https://img.shields.io/badge/license-BSD--2--Clause-blue)
6
6
  ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
7
7
 
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
5
5
  [project]
6
6
  name = "python-waterloo-lexer"
7
7
  description = "A pygments lexer derived from the Python lexer, for Waterloo docstrings"
8
- readme = "README_PYPI.md"
8
+ readme = "README.md"
9
9
  dependencies = ["pygments"]
10
10
  requires-python = ">=3.10"
11
11
  authors = [{ name = "Uwe" }]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python-waterloo-lexer
3
- Version: 0.5.3
3
+ Version: 0.5.5
4
4
  Summary: A pygments lexer derived from the Python lexer, for Waterloo docstrings
5
5
  Author: Uwe
6
6
  License: BSD-2-Clause
@@ -17,7 +17,7 @@ Requires-Dist: pygments
17
17
  # Python-Waterloo Lexer
18
18
 
19
19
  ![Status](https://img.shields.io/badge/status-pre--release-orange)
20
- ![Version](https://img.shields.io/badge/version-_VERSION_-blue)
20
+ ![Version](https://img.shields.io/badge/version-0.5.5-blue)
21
21
  ![License](https://img.shields.io/badge/license-BSD--2--Clause-blue)
22
22
  ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
23
23
 
@@ -1,5 +1,4 @@
1
1
  README.md
2
- README_PYPI.md
3
2
  pyproject.toml
4
3
  python_waterloo_lexer.py
5
4
  python_waterloo_lexer.egg-info/PKG-INFO
@@ -41,7 +41,7 @@ from pygments.token import Error, Generic, Keyword, Name, String, Literal, Numbe
41
41
 
42
42
  #----- Changelog ----------------------------------------------#
43
43
 
44
- __version__ = "0.5.3"
44
+ __version__ = "0.5.5"
45
45
 
46
46
  #----- Constants ----------------------------------------------#
47
47
  RE_SECTION = re.compile(
@@ -1,62 +0,0 @@
1
- # Python-Waterloo Lexer
2
-
3
- ![Status](https://img.shields.io/badge/status-pre--release-orange)
4
- ![Version](https://img.shields.io/badge/version-_VERSION_-blue)
5
- ![License](https://img.shields.io/badge/license-BSD--2--Clause-blue)
6
- ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
7
-
8
- `python-waterloo-lexer` is a Pygments lexer for Python files that contain
9
- Waterloo docstrings.
10
-
11
- It can be used with `pygmentize` and other tools that load Pygments lexers via
12
- entry points.
13
-
14
- ## What it provides
15
-
16
- - a `python-waterloo` Pygments lexer alias
17
- - syntax highlighting for Python files with Waterloo docstrings
18
- - installation via PyPI, local checkout, or Git URL
19
-
20
- ## Installation
21
-
22
- ```bash
23
- pip install python-waterloo-lexer
24
- ```
25
-
26
- ## Quick test
27
-
28
- After installation, the lexer is available under the alias
29
- `python-waterloo`.
30
-
31
- ```bash
32
- pygmentize -l python-waterloo -f terminal16m <file.py>
33
- ```
34
-
35
- You can also check whether Pygments lists the lexer:
36
-
37
- ```bash
38
- pygmentize -L lexers | grep -i waterloo || true
39
- ```
40
-
41
- ## Terminal viewer
42
-
43
- For a quick terminal preview, a `less` alias can be handy:
44
-
45
- ```bash
46
- alias lessh='LESSOPEN="| pygmentize -O style=monokai %s" less -M -R'
47
- ```
48
-
49
- Then open files with:
50
-
51
- ```bash
52
- lessh <file.py>
53
- ```
54
-
55
- ## Project repository
56
-
57
- Development happens in the Waterloo repository:
58
-
59
- - <https://github.com/uwe-at-sdv/sdv_doc_waterloo>
60
-
61
- The repository also contains related tooling, documentation, and editor
62
- integrations for Waterloo docstrings.