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.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.4.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

pygrammalecte-1.4.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pygrammalecte-1.4.0.tar.gz
Algorithm Hash digest
SHA256 a90660b8592d719d936e8c3ee4302b4d34701ccb94ce9a4a536abbed04bd2b22
MD5 b12949d8ecc5db92084d58a47e92c995
BLAKE2b-256 aa1f531f7a248ee9df4e2da42c16a2ae6bb5c4dd1a5880f0b537479f9bda8f93

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pygrammalecte-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79d8c9c6490f3773af3195fd00b867762647a0fbfc8d9a2cd95ab4e26bf91dcf
MD5 b4358bd9e33cccf8a595a7b5f4f142aa
BLAKE2b-256 be0cd9d1d515e741e3622574380fbd897fed53a1e6cab26f7e916ba47c5e22a3

See more details on using hashes here.

Supported by

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