acrolint 0.1.0__py3-none-any.whl

acrolint/__init__.py

@@ -0,0 +1,2 @@
+from .main import acrolint
+from .main import output_file

acrolint/main.py

@@ -0,0 +1,146 @@
+import re
+
+def file_text_extract(file_path):
+    """
+    Extracts the text content from a file.
+
+    Args:
+        file_path (str): The path to the file.
+
+    Returns:
+        str: The text content of the file.
+    """
+    try:
+        with open(file_path, "r", encoding="utf-8") as f:
+            return f.read()
+    except Exception as e:
+        print(f"Error reading file {file_path}: {e}")
+        return ""
+def regex_extract(pattern, text):
+    """
+    Extracts all matches of a regex pattern from the given text.
+
+    Args:
+        pattern (str): The regex pattern to search for.
+        text (str): The text to search within.
+    
+    Returns:
+        list: A list of all matches found.
+    """
+    try:
+        return re.findall(pattern, text)
+    except re.error as e:
+        print(f"Regex error: {e}")
+        return []
+def collect_acronyms(text):
+    """
+    Collects all acronyms from the specified file.
+
+    Args:
+        file_path (str): The path to the file.
+    
+    Returns:
+        list: A list of all acronyms found.
+    """
+    
+    # Simple regex to find acronyms (uppercase letters)
+    return regex_extract(r'\b[A-Z]{2,}\b', text)
+def find_acronym_definitions(text):
+    """
+    Finds acronym definitions in the given text.
+
+    Args:
+        text (str): The text to search within.
+    
+    Returns:
+        list: A list of all acronym definitions found.
+    """
+    patterns = [
+    r'([A-Z][A-Za-z\s\-&]+)\s*\(([A-Z]{2,10})\)',
+    r'\b([A-Z]{2,10})\s*\(([A-Z][A-Za-z\s\-&]+)\)']
+    results = []
+    for pattern in patterns:
+        results.extend(regex_extract(pattern, text))
+    return results
+
+def find_undefined_acronyms(text, defined_acronyms):
+    all_acronyms = collect_acronyms(text)
+    all_unique_acronyms = set(all_acronyms)
+    defined_acronyms_short = [acronym[0] for acronym in defined_acronyms]
+
+    return [acronym for acronym in all_unique_acronyms if acronym not in defined_acronyms_short]
+def index_to_line(text, index):
+    return text[:index].count("\n") + 1
+def firstusage(files, pattern):
+    result = []
+    for file in files:
+        text = file_text_extract(file)
+
+        for match in re.finditer(pattern, text):
+            result.append(
+                index_to_line(text, match.start())
+                )
+                
+        if match:
+            break  # Stop searching after the first match in the current file
+    return result[0]
+def output_file(file_path, orgonised_data):
+    if file_path.endswith(".json"):
+        import json
+        with open(file_path, "w", encoding="utf-8") as f:
+            json.dump(orgonised_data, f, indent=4)
+def acrolint(file_paths):
+    """
+    Main function to process the given file paths and find acronyms and their definitions.
+
+    Args:
+        file_paths (list): A list of file paths to process.
+    Returns:
+        dict: A dictionary containing acronyms, their definitions, and first usage information.
+    """
+    orgonised_data = {}
+    for file_path in file_paths:
+        text = file_text_extract(file_path)
+        acronyms = find_acronym_definitions(text)
+        undefined_acronyms = find_undefined_acronyms(text, acronyms)
+
+        for acronym in undefined_acronyms:
+            first_usage = firstusage([file_path], r'\b' + re.escape(acronym) + r'\b')
+            orgonised_data[acronym] = {
+                "definition": None,
+                "first_usage": first_usage,
+                "defined": False
+            }
+
+        for acronym in acronyms:
+            first_usage = firstusage([file_path], r'\b' + re.escape(acronym[0]) + r'\b')
+            orgonised_data[acronym[0]] = {
+                "definition": acronym[1],
+                "first_usage": first_usage,
+                "defined": True
+            }
+    return orgonised_data
+
+def main():
+    # Example usage
+    file_path = "tests/test_files/main.tex"  # Replace with your file path
+    text = file_text_extract(file_path)
+    acronyms = find_acronym_definitions(text)
+    undefined_acronyms = find_undefined_acronyms(text, acronyms)
+    orgonised_data = {}
+    for acronym in undefined_acronyms:
+    
+        first_usage = firstusage([file_path], r'\bAI\b')
+        orgonised_data[acronym] = {
+            "definition": None,
+            "first_usage": first_usage,
+            "defined": False
+        }
+    for acronym in acronyms:
+        first_usage = firstusage([file_path], r'\b' + re.escape(acronym[0]) + r'\b')
+        orgonised_data[acronym[0]] = {
+            "definition": acronym[1],
+            "first_usage": first_usage,
+            "defined": True
+        }
+    output_file("tests/test_files/output.json", orgonised_data)

acrolint-0.1.0.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: acrolint
+Version: 0.1.0
+Summary: A linter for acronyms in text files.
+Author: Mitchell Gerrard
+License: MIT
+Project-URL: Homepage, https://github.com/Mitchell-Gerrard/acrolint
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Acrolint
+
+**Acrolint** is a extreamly light weight python library for extraction of acronyms used in your latex and text files, that grow to long to remeber where you used your BUAs (Big Ugly Actonyms)
+
+---
+
+## ✨ Features
+- Extracting both the acrronyms and the deffintions for filling in any acronym pages to your work
+- Detect any acronyms you did not define all the UDAs
+- Track where they are first used sao you can fill in the deffinions or check they are deffomed were thy are firt used in your multi file project
+- Suports multiple files
+- JSON file output for the ability to store all of your acronyms and to enable down stream anaylysis
+
+---
+
+## 📦 Installation
+
+```bash
+pip install acrolint
+
+## 💨 Fast start
+from acrolint import acrolint, output_file
+
+files = [
+    "chapter1.tex",
+    "chapter2.tex",
+    "chapter3.tex"
+]
+
+result = acrolint(files)
+
+output_file(result, "acronyms.json")

acrolint-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+acrolint/__init__.py,sha256=Pc7tPUF1qzRV8yfESucIyvec79zJ6ruoJQzDmcXkLiw,56
+acrolint/main.py,sha256=fs85Qs5TBJVVTOzAuJcd_sRTuiysCwKBpkMPXjej4Go,4627
+acrolint-0.1.0.dist-info/licenses/LICENSE,sha256=VZ4ClAnzSICkzfnMkzQ8eV_BwidyFQMqlm1QkjumcBs,1072
+acrolint-0.1.0.dist-info/METADATA,sha256=T-vYLW5kdCyfcd5wpSgoVJVZtBpad9LG_4Cboqojkkc,1364
+acrolint-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+acrolint-0.1.0.dist-info/top_level.txt,sha256=kEd35b9DeV6UAeGdd9jOHdRVC_03ZetlRYr0kxhakVw,9
+acrolint-0.1.0.dist-info/RECORD,,

acrolint-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

acrolint-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mitchell Gerrard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

acrolint-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+acrolint