This project has been archived by its maintainers, and is no longer receiving any updates.
CCFT-PyMarkdown
⚠️ PROJECT ARCHIVED ⚠️
This project is now officially archived and no longer maintained. It was created as a temporary wrapper to suppress false-positive failures from PyMarkdown that have now been resolved. Please install and make use of the upstream project instead.
A Python wrapper around jackdewinter's PyMarkdown linter to suppress errors, caused by custom-formatted tables in Markdown files
When running PyMarkdown it may incorrectly flag errors inside a table that has correct formatting. Using this wrapper, the errors will be suppressed by temporarily cleaning any custom-formatted tables.
Installation
Run as a uv tool (no installation necessary)
uvx -- ccft-pymarkdown --help
Install permenantly as a uv tool
uv tool install CCFT-PyMarkdown
Install using pip after creating a virtual environment
path/to/venv/python -m pip install CCFT-PyMarkdown
The +[git-python]+ https://packaging.python.org/specifications/dependency-specifiers#extras[Extra]
This package can also be installed with the [git-python] optional dependency.
This will allow the identification of hidden/excluded files to make use of your project’s .gitignore file.
Run as a uv tool (no installation necessary)
uvx --from CCFT-PyMarkdown[git-python] -- ccft-pymarkdown --help
Install permenantly as a uv tool
uv tool install CCFT-PyMarkdown[git-python]
Install using pip after creating a virtual environment
path/to/venv/python -m pip install CCFT-PyMarkdown[git-python]
Usage
These commands will only work correctly either after installation as a permenant uv tool, or after activating a virtual environment with CCFT-PyMarkdown installed.
Replace the command name ccft-pymarkdown with uvx -- ccft-pymarkdown, to run any of the following commands in an ephemeral envrionment.
💡 TIP
If you require sending additional arguments to the pymarkdown command you must manually clean any custom-formatted tables and then manually restore the MarkDown files.
Output the help message
ccft-pymarkdown --help
Run with increased verbosity
ccft-pymarkdown <command> -v
Run without any logging output (incompatible with the -v flag)
ccft-pymarkdown <command> -q
Output the current version number
ccft-pymarkdown --version
Scanning All Files After Cleaning Custom-Formatted Tables
To perform linting using PyMarkdown, after cleaning custom-formatted tables within any MarkDown files, use the scan-all action
ccft-pymarkdown scan-all
Scan files according to your .gitignore file (Only available when the [git-python] extra is installed)
ccft-pymarkdown scan-all --with-git
Scan files without ignoring any hidden/excluded files
ccft-pymarkdown scan-all --no-git
Manually Cleaning Custom-Formatted Tables
To manually clean custom-formatted-tables within any MarkDown files without running PyMarkdown, use the clean action
ccft-pymarkdown clean MyNotes.md MyReport.md
Clean a whole directory and additional files
ccft-pymarkdown clean my-notes/ MyReport.md
Clean a whole directory according to your .gitignore file (Only available when the [git-python] extra is installed)
ccft-pymarkdown clean --with-git my-notes/
Clean a whole directory without ignoring any hidden/excluded files
ccft-pymarkdown clean --no-git my-notes/
Clean files without making any changes, only report what would have been changed
ccft-pymarkdown clean --dry-run MyNotes.md MyReport.md
Manually Restoring https://wikipedia.org/wiki/Markdown[MarkDown] Files
To manually restore any cleaned MarkDown files, use the restore action
ccft-pymarkdown restore MyNotes.md MyReport.md
Restore a whole directory and additional files
ccft-pymarkdown restore my-notes/ MyReport.md
Restore files without making any changes, only report what would have been changed
ccft-pymarkdown restore --dry-run MyNotes.md MyReport.md
Metadata
Release files for CCFT-PyMarkdown 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ccft_pymarkdown-3.0.0.tar.gz | 16.8 kB | Without provenance | Details for ccft_pymarkdown-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ccft_pymarkdown-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for ccft_pymarkdown-3.0.0-py3-none-any.whl |
Total release size: 35.8 kB
Release files / ccft_pymarkdown-3.0.0.tar.gz
| Download URL | ccft_pymarkdown-3.0.0.tar.gz |
|---|---|
| Size | 16.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ef213521d1789ff8dbecc04333268627dc278460361c36994b7fdfeb92a88dd9
|
|
BLAKE2b-256 checksum How to use checksums |
08476537c98b0b43a347b60c2094f949144aab73c6e2b95f239a841e616b6363
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.22
|
Release files / ccft_pymarkdown-3.0.0-py3-none-any.whl
| Download URL | ccft_pymarkdown-3.0.0-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a256335cad3f3a3a86b279f03ff7bc62f039f97d23b07a543b73ad2a1b791ea9
|
|
BLAKE2b-256 checksum How to use checksums |
92f139a4edbe0aad41ed3f0527e0e35bcc95868fb437fbefdc281df4c6b4d6ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.22
|
Security for CCFT-PyMarkdown 3.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.