pymarkdown_api_markdown_file_linting_quickstart.py

1import sys
2from pymarkdown.api import PyMarkdownApi, PyMarkdownApiException
3
4def run_linting():
5    # Initialize the PyMarkdown API
6    api = PyMarkdownApi()
7
8    try:
9        # Scan a specific file for linting errors
10        # You can also use scan_path("directory_path") to scan a directory
11        print("Starting linting process...")
12        scan_result = api.scan_path("example.md")
13        
14        # Check if any linting violations were found
15        if scan_result.scan_failures:
16            print(f"Found {len(scan_result.scan_failures)} linting issues:")
17            for failure in scan_result.scan_failures:
18                print(f"  - {failure}")
19        else:
20            print("No linting issues found!")
21
22    except PyMarkdownApiException as ex:
23        print(f"An error occurred during linting: {ex}")
24        sys.exit(1)
25
26if __name__ == "__main__":
27    run_linting()