syntaxlight 0.0.1__tar.gz

syntaxlight-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 kami-lu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

syntaxlight-0.0.1/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: syntaxlight
+Version: 0.0.1
+Summary: syntax highlight based on EBNF
+Home-page: https://github.com/luzhixing12345/syntaxlight
+License: MIT
+Author: luzhixing12345
+Author-email: luzhixing12345@163.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Project-URL: Documentation, https://luzhixing12345.github.io/syntaxlight/
+Project-URL: Repository, https://github.com/luzhixing12345/syntaxlight
+Description-Content-Type: text/markdown
+
+# syntaxlight
+
+syntaxlight 是一个基于 EBNF 的语法高亮的 python 库, 您可以 [在线浏览]() 所有文法的高亮结果
+
+目前支持 C Python Lua 等常见编程语言和 json xml 等文件格式的文法解析, 默认使用 Vscode 风格的高亮显示
+
+除此之外也支持自定义 EBNF 规则匹配文本, 以及自定义高亮颜色
+
+## 安装
+
+```bash
+pip install syntaxlight
+```
+
+## 快速开始
+
+```python
+import syntaxlight
+
+code = """
+#include <stdio.h>
+
+int main() {
+    printf("hello world!\n");
+    return 0;
+}
+"""
+
+html = syntaxlight.parse(code, 'C')
+print(html)
+```
+
+syntaxlight 通常用于配合 Markdown 解析器完成网页 html 中 `<pre><code>` 标签内的代码高亮, 因此为了正确高亮显示还需要导出 css 文件
+
+```python
+import syntaxlight
+
+syntaxlight.export_css(['c','python','lua'], export_name='index.css')
+# 保存得到 index.css 文件, 将其引入 html 即可: <link rel='stylesheet' href=./index.css />
+```
+
+除此之外为了方便用户使用, syntaxlight 提供了一个简易的示例用于预览结果和调整
+
+```python
+import syntaxlight
+
+syntaxlight.example_display()
+```
+
+运行可以得到一个 `syntaxlight_example/` 文件夹, 使用浏览器打开其中的 index.html 可以快速预览 文法高亮结果 以及 切换不同高亮风格, 并提供了一键导出的快捷选项
+
+## 文档和 API
+
+[syntaxlight 使用文档](https://luzhixing12345.github.io/syntaxlight/)
+
+文档中提供了比较详细的 API 使用方法, 以及对于默认配置的修改情况
+
+## 参考
+
+- [pygments](https://pygments.org/)

syntaxlight-0.0.1/README.md

@@ -0,0 +1,60 @@
+# syntaxlight
+
+syntaxlight 是一个基于 EBNF 的语法高亮的 python 库, 您可以 [在线浏览]() 所有文法的高亮结果
+
+目前支持 C Python Lua 等常见编程语言和 json xml 等文件格式的文法解析, 默认使用 Vscode 风格的高亮显示
+
+除此之外也支持自定义 EBNF 规则匹配文本, 以及自定义高亮颜色
+
+## 安装
+
+```bash
+pip install syntaxlight
+```
+
+## 快速开始
+
+```python
+import syntaxlight
+
+code = """
+#include <stdio.h>
+
+int main() {
+    printf("hello world!\n");
+    return 0;
+}
+"""
+
+html = syntaxlight.parse(code, 'C')
+print(html)
+```
+
+syntaxlight 通常用于配合 Markdown 解析器完成网页 html 中 `<pre><code>` 标签内的代码高亮, 因此为了正确高亮显示还需要导出 css 文件
+
+```python
+import syntaxlight
+
+syntaxlight.export_css(['c','python','lua'], export_name='index.css')
+# 保存得到 index.css 文件, 将其引入 html 即可: <link rel='stylesheet' href=./index.css />
+```
+
+除此之外为了方便用户使用, syntaxlight 提供了一个简易的示例用于预览结果和调整
+
+```python
+import syntaxlight
+
+syntaxlight.example_display()
+```
+
+运行可以得到一个 `syntaxlight_example/` 文件夹, 使用浏览器打开其中的 index.html 可以快速预览 文法高亮结果 以及 切换不同高亮风格, 并提供了一键导出的快捷选项
+
+## 文档和 API
+
+[syntaxlight 使用文档](https://luzhixing12345.github.io/syntaxlight/)
+
+文档中提供了比较详细的 API 使用方法, 以及对于默认配置的修改情况
+
+## 参考
+
+- [pygments](https://pygments.org/)

syntaxlight-0.0.1/pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "syntaxlight"
+version = "0.0.1"
+description = "syntax highlight based on EBNF"
+authors = ["luzhixing12345 <luzhixing12345@163.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/luzhixing12345/syntaxlight"
+documentation = "https://luzhixing12345.github.io/syntaxlight/"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

syntaxlight-0.0.1/syntaxlight/__init__.py

@@ -0,0 +1,4 @@
+
+from .syntax_parse import parse
+from .export import export_css
+from .example import example

syntaxlight-0.0.1/syntaxlight/example.py

@@ -0,0 +1,5 @@
+
+
+
+def example_display():
+    ...

syntaxlight-0.0.1/syntaxlight/export.py

@@ -0,0 +1,4 @@
+
+
+def export_css(languages: list[str] | str, export_name:str = "index.css", style:str = "vscode"):
+    ...    

syntaxlight-0.0.1/syntaxlight/syntax_parse.py

@@ -0,0 +1,5 @@
+
+
+
+def parse(text: str, language: str = 'guess') -> str:
+    ...