Skip to main content

Grammalecte, le correcteur grammatical en Python

Project description

pygrammalecte

PyPI PyPI Code style: Ruff Downloads Test Coverage Maintainability

(english version at the bottom of this document)

Grammalecte, le correcteur grammatical en Python.

Pour être précis, ce projet n’est pas Grammalecte, mais un « wrapper » permettant de l’utiliser facilement en Python.

Installation

Vous devez utiliser un Python en version supérieure ou égale à 3.9.

L’utilisation d’un environnement virtuel est fortement recommandé.

python3 -m pip install pygrammalecte

Utilisation

Vérification d’une chaîne de caractères

from pygrammalecte import grammalecte_text

texte_bidon = """\
Coucou, je veut du fromage.
Je sais coder en VHDL.
Le VHDL est est compliquer.
"""

for message in grammalecte_text(texte_bidon):
    print(message)

Vérification d’un fichier

Vous devez fournir le chemin du fichier en str ou en pathlib.Path. Le fichier doit être un fichier texte brut (pas un fichier Word ou OpenDocument par exemple).

from pathlib import Path

from pygrammalecte import grammalecte_file

filepath = Path("toto.txt")

for message in grammalecte_file(filepath):
    print(message)

Messages générés

Les fonctions grammalecte_file et grammalecte_text sont des générateurs, vous pouvez donc les utiliser dans une boucle for. Elles génèrent des GrammalecteMessage.

Deux types de GrammalecteMessage existent :

  • GrammalecteSpellingMessage qui a comme attributs :

    • line : numéro de la ligne dans le texte vérifié
    • start : numéro du caractère de début de l’erreur dans la ligne
    • end : numéro du caractère de fin de l’erreur dans la ligne
    • word : le mot non reconnu par Grammalecte
    • message : message d’erreur
  • GrammalecteGrammarMessage qui a comme attributs :

    • line : numéro de la ligne dans le texte vérifié
    • start : numéro du caractère de début de l’erreur dans la ligne
    • end : numéro du caractère de fin de l’erreur dans la ligne
    • url : l’URL fournie par Grammalecte
    • color : une couleur fournie par Grammalecte, c’est une liste de 3 entiers entre 0 et 255.
    • suggestions : propositions de correction
    • message : message d’erreur
    • rule : identifiant de la règle violée
    • type : type de la règle ("conj"…)

Changelog

Version 1.5.0

  • Amélioration du support de Windows

Version 1.4.0

  • Passage à uv
  • Compatibilité Python 3.9 à 3.13
  • Utilisation de Grammalecte v2.1.1

Version v1.3.0

  • Correction due à un fonctionnement étrange de Grammalecte v1.12.0

Version v1.2.0

  • Utilisation de Grammalecte v1.12.0

Version v1.1.0

  • Ajout de l'attribut message pour GrammalecteSpellingMessage

Version v1.0.0

  • Refactoring
  • Ajout de l'intégration continue

Version v0.1.0

  • Première version !
  • Utilisation de Grammalecte v1.11.0

English version

This is a wrapper for the french grammatical checker called Grammalecte.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygrammalecte-1.5.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygrammalecte-1.5.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file pygrammalecte-1.5.0.tar.gz.

File metadata

  • Download URL: pygrammalecte-1.5.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.30

File hashes

Hashes for pygrammalecte-1.5.0.tar.gz
Algorithm Hash digest
SHA256 48c99525f75f78df536bfca12150d3e0f8ca322235535768fca1e03dca2bbd83
MD5 ba58683c064ec196b071178a3769443d
BLAKE2b-256 31c8b9e842180a6549b82b13be3ff4e4878b5cfb772cde1e15762aba7c65b2cc

See more details on using hashes here.

File details

Details for the file pygrammalecte-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pygrammalecte-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 460c293dc7ca4c7bad720d30a355f5fef59794078b452f81eed52474846b8103
MD5 79a429822e04f1053632b48a5d8950c4
BLAKE2b-256 d60a1d9c3f6563ad5a6acb7bf191c7b267ca1677ddad20fd772d7aa46e11821c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page