vale

import os from vale import Vale # Vale requires a .vale.ini config file and a StylesPath directory. # For a quickstart, we'll create minimal ones in a temporary directory. # In a real project, these would be managed in your project structure. config_content = """ StylesPath = styles MinAlertLevel = warning [*.md] BasedOn = proselint """ style_content = """ # styles/proselint/SomeRule/Vocab.yml # Minimal example rule (if you had a custom rule) """ # Create a temporary directory structure # In a real application, you'd manage config_dir and style_dir appropriately import tempfile import shutil try: with tempfile.TemporaryDirectory() as temp_dir: config_dir = os.path.join(temp_dir, ".vale") styles_dir = os.path.join(config_dir, "styles", "proselint") os.makedirs(styles_dir, exist_ok=True) with open(os.path.join(config_dir, ".vale.ini"), "w") as f: f.write(config_content) # You'd typically install actual styles here or reference system-wide ones # For this quickstart, we just need the directories to exist. vale_instance = Vale(config_path=os.path.join(config_dir, ".vale.ini")) text_to_lint = "This is a very simple test. I will be using bad grammar." # Lint the text. Output format is typically JSON. # The default output is a list of dictionaries, one for each alert. alerts = vale_instance.lint(text_to_lint, syntax='md') print(f"Found {len(alerts)} alerts:") for alert in alerts: print(f" - [{alert['Severity']}] {alert['Message']} (Rule: {alert['Check']})") except Exception as e: print(f"An error occurred: {e}") print("Ensure Vale CLI is successfully downloaded on first run and config is valid.")