{"id":18458923,"url":"https://github.com/pygments/pygments-plugin-scaffolding","last_synced_at":"2025-04-23T17:32:20.630Z","repository":{"id":229689631,"uuid":"714744997","full_name":"pygments/pygments-plugin-scaffolding","owner":"pygments","description":"Boilerplate for writing Pygments plugins","archived":false,"fork":false,"pushed_at":"2023-12-26T14:47:41.000Z","size":4,"stargazers_count":6,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T10:16:14.268Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pygments.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-05T18:31:51.000Z","updated_at":"2025-01-04T16:38:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"16ddd80d-fe35-4489-8200-df932bfe687e","html_url":"https://github.com/pygments/pygments-plugin-scaffolding","commit_stats":null,"previous_names":["pygments/pygments-plugin-scaffolding"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygments%2Fpygments-plugin-scaffolding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygments%2Fpygments-plugin-scaffolding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygments%2Fpygments-plugin-scaffolding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygments%2Fpygments-plugin-scaffolding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pygments","download_url":"https://codeload.github.com/pygments/pygments-plugin-scaffolding/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250480484,"owners_count":21437552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T08:20:54.205Z","updated_at":"2025-04-23T17:32:20.623Z","avatar_url":"https://github.com/pygments.png","language":null,"readme":"# Pygments plugin examples\n\nThis repository contains an example of the project scaffolding needed to write a\nplugin lexer/formatter/style/filter for the [Pygments](https://pygments.org)\nsyntax highlighter.\n\nRoadmap:\n\n```\n.\n├── example_filter.py    # An example filter\n├── example_formatter.py # An example formatter\n├── example_lexer.py     # An example lexer\n├── example_style.py     # An example style\n├── pyproject.toml       # The Python package metadata file\n├── README.md            # You are here\n└── test.exmpl           # A test file in the mockup language of the example lexer\n```\n\nTo be usable, plugins must be installed. If you are running the `pygmentize`\ncommand, you probably want to use a\n[virtual environment](https://docs.python.org/3/library/venv.html)\nto avoid installing packages globally. For example, here is how to create\na virtual environment and install this set of plugins into it:\n\n```\npython -m venv venv/\nvenv/bin/pip install . # install the project in current directory into the virtual environment\nvenv/bin/pygmentize ... # use the pygmentize command from the virtual environment\n```\n\nAlternatively, since this example uses the [Hatch](https://hatch.pypa.io)\ntool, you may use\n\n```\nhatch run pygmentize ...\n```\n\nIf you are using Pygments from Python, possibly through a tool like Sphinx,\nmkdocs, etc., then you just need to install the plugin in the same environment\nas the one where you installed Pygments.\n\nIf you want to distribute your plugin on PyPI, you should read the\n[packaging user guide](https://packaging.python.org/en/latest/tutorials/packaging-projects).\n\n\n#### License for this template\n\nThere isn't much copyrightable content here, but if you are worried about reuse:\n\nCopyright (C) 2023 by Jean Abou Samra \u003cjean@abou-samra.fr\u003e\n\nPermission to use, copy, modify, and/or distribute this software for any purpose\nwith or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS\nOF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER\nTORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF\nTHIS SOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpygments%2Fpygments-plugin-scaffolding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpygments%2Fpygments-plugin-scaffolding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpygments%2Fpygments-plugin-scaffolding/lists"}