bibtex-linter 1.0.0__tar.gz

bibtex_linter-1.0.0/.github/workflows/ci.yaml

@@ -0,0 +1,52 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  X_PYTHON_MIN_VERSION: "3.11"
+
+jobs:
+  test:
+    # This job runs the unittests on the python versions specified down at the matrix
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.X_PYTHON_MIN_VERSION }}
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+      - name: Test with coverage + unittest
+        run: |
+          coverage run --source=bibtex_linter -m unittest
+      - name: Report test coverage
+        if: ${{ always() }}
+        run: |
+          coverage report -m
+
+  static-analysis:
+    # This job runs static code analysis, namely pycodestyle and mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.X_PYTHON_MIN_VERSION }}
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+      - name: Check typing with MyPy
+        run: |
+          mypy --strict bibtex_linter test
+      - name: Check code style with PyCodestyle
+        run: |
+          pycodestyle --count --max-line-length 120 bibtex_linter test

bibtex_linter-1.0.0/.github/workflows/release.yaml

@@ -0,0 +1,36 @@
+name: release
+
+on:
+  release:
+    types: [published]
+
+env:
+  X_PYTHON_MIN_VERSION: "3.11"
+
+jobs:
+  publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{env.X_PYTHON_MIN_VERSION }}
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Create source and wheel dist
+      # (2024-12-11, s-heppner)
+      # The PyPI Action expects the dist files in a toplevel `/dist` directory,
+      # so we have to specify this as output directory here.
+      run: |
+        python -m build --outdir dist
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

bibtex_linter-1.0.0/.gitignore

@@ -0,0 +1,183 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Ignore the tex files in the `test_template` directory, since we do not want to accidentally publish an official
+# template under a different license
+test/test_template/*.tex
+test/test_template/*.pdf
+test/test_template/*.cls
+
+# Ignore the version.py file
+bibtex_linter/version.py

bibtex_linter-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 s-heppner
+
+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.

bibtex_linter-1.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: bibtex_linter
+Version: 1.0.0
+Summary: A Python tool to parse BibTeX entries and run (custom) checks on them.
+Author-email: Sebastian Heppner <mail@s-heppner.com>
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pycodestyle; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Dynamic: license-file
+
+# python-bibtex-linter
+A Python tool to parse BibTeX entries and run (custom) checks on them.
+
+```commandline
+> bibtex_linter refs.bib
+
+Entry 'SomeBook' of type 'BOOK' failed verification:
+  ❌ Invariant Violations:
+    - Entry 'SomeBook' misses the following required fields: [publisher]
+    - Entry 'SomeBook' has fields present that would be omitted in the compiled document: [url]. This could lead to a loss of information.
+    
+Found 2 invariant violations in 17 entries.
+```
+
+## Motivation
+I've always assumed that I just needed to take care that my `references.bib` file was in order, that as many of the
+fields of the entries in there were filled, and then I could easily use them to create standard-conforming citations in
+my LaTeX documents. 
+As it turns out, a lot of different citation styles omit various fields, and it's an overall mess. 
+Therefore, I created this tool (in Python, since that's what I know best), that can parse the entries and then performs
+arbitrary (self-defined) invariant checks on them.
+
+In my field the most used citation style is `IEEEtran` so this is how I've defined the default rules of the script.
+I've written down the observations on which the rules are based [here](test/test_template/IEEEtran_observations.md).
+
+It is however relatively easy to define your own [custom ruleset](#advanced-custom-rulesets), should the need arise.
+
+## How to use:
+First we need to install the tool, I recommend to use [pipx](https://github.com/pypa/pipx) for that:
+```commandline
+pipx install .
+```
+
+### Basic Usage
+Then you can call the script the following way:
+```commandline
+bibtex_linter path/to/refs.bib
+```
+
+The script will parse the file, perform the checks and print out the results. 
+
+> [!note]
+> As the `bibtex_linter` returns exit code `0`, if all checks have passed and `1`, if violations were found, 
+> you could also use it in the CI of your LaTeX projects. 
+
+### Advanced: Custom Rulesets
+
+> [!warning]
+> Custom rulesets are plain Python code and will be executed on your machine.
+> If you wouldn't trust running `python3 my_rules.py`, you shouldn't use it with `bibtex_linter`.
+> **Only use rulesets from sources you trust!**
+
+It is also possible to define your own rules inside a Python file. 
+Let's call it `my_own_rules.py`.
+Creating your own rule is as simple as:
+
+```Python
+from typing import List
+
+from bibtex_linter.parser import BibTeXEntry, EntryType
+from bibtex_linter.verification import linter_rule
+
+
+@linter_rule(entry_type=EntryType.ARTICLE)
+def check_article(entry: BibTeXEntry) -> List[str]:
+    """
+    Check that a `BibTeXEntry` has a nonempty `author` field.
+
+    :param entry: The BibTeXEntry
+    :return: A list of string descriptions of rule violations for this entry.
+    """
+    if not entry.fields.get("author"):
+        return [f"Entry '{entry.name}' misses the required field author!"]
+    return []
+```
+
+As you can see, we created a method and designated that it is a linter rule by using the `@linter_rule` decorator.
+The method needs to have a specific interface: 
+It needs to take the `BibTeXEntry` to be checked as input argument, and it needs to return a List of strings explaining
+the rule violations for that `BibTeXEntry`. 
+If there are no rule violations, it should return an empty list. 
+
+This rule only gets executed for entries of the `ARTICLE` type, as specified by the decorator argument.
+If we left the `entry_type` argument empty, this check would be executed on all entries.
+
+For more inspiration on what you could define as your custom rules, have a look into `bibtex_linter/default_rules.py`.
+After defining the rules in `my_own_rules.py`, we can execute them on a BibTeX file like this: 
+
+```commandline
+bibtex_linter path/to/refs.bib path/to/my_own_rules.py
+```
+
+Let's reiterate the warning from beforehand:
+
+> [!warning]
+> Custom rulesets are plain Python code and will be executed on your machine.
+> If you wouldn't trust running `python3 my_rules.py`, you shouldn't use it with `bibtex_linter`.
+> **Only use rulesets from sources you trust!**
+
+
+## Definition of used Terms
+If you're unfamiliar with BibTex, here's a short list of terms, so that you can better understand the output of the
+`bibtex_linter`.
+
+### Entry
+An entry to the BibTeX file:
+```LaTeX
+@article{basic_case,
+  author = {Test author},
+  title = {Standard field format},
+  year = {2020}
+}
+```
+
+### Field
+A field inside an entry, consists of a `key` and a `value`:
+```LaTeX
+author = {Test author},
+```
+In this case, `"author"` would be the `key` and `"Test author"` the `value`. 
+
+> [!note]
+> There are many different ways of wrapping the value text, from `{}` via `{{}}` or `""`.
+> This tool removes these wrapping characters and only considers the text inside of them as `value`.
+
+### Entry Type
+The entry type specifies the available fields and is written behind the `@` and in front of the first `{` of an entry:
+```LaTeX
+@article{...}
+@conference{...}
+@online{...}
+```

bibtex_linter-1.0.0/README.md

@@ -0,0 +1,132 @@
+# python-bibtex-linter
+A Python tool to parse BibTeX entries and run (custom) checks on them.
+
+```commandline
+> bibtex_linter refs.bib
+
+Entry 'SomeBook' of type 'BOOK' failed verification:
+  ❌ Invariant Violations:
+    - Entry 'SomeBook' misses the following required fields: [publisher]
+    - Entry 'SomeBook' has fields present that would be omitted in the compiled document: [url]. This could lead to a loss of information.
+    
+Found 2 invariant violations in 17 entries.
+```
+
+## Motivation
+I've always assumed that I just needed to take care that my `references.bib` file was in order, that as many of the
+fields of the entries in there were filled, and then I could easily use them to create standard-conforming citations in
+my LaTeX documents. 
+As it turns out, a lot of different citation styles omit various fields, and it's an overall mess. 
+Therefore, I created this tool (in Python, since that's what I know best), that can parse the entries and then performs
+arbitrary (self-defined) invariant checks on them.
+
+In my field the most used citation style is `IEEEtran` so this is how I've defined the default rules of the script.
+I've written down the observations on which the rules are based [here](test/test_template/IEEEtran_observations.md).
+
+It is however relatively easy to define your own [custom ruleset](#advanced-custom-rulesets), should the need arise.
+
+## How to use:
+First we need to install the tool, I recommend to use [pipx](https://github.com/pypa/pipx) for that:
+```commandline
+pipx install .
+```
+
+### Basic Usage
+Then you can call the script the following way:
+```commandline
+bibtex_linter path/to/refs.bib
+```
+
+The script will parse the file, perform the checks and print out the results. 
+
+> [!note]
+> As the `bibtex_linter` returns exit code `0`, if all checks have passed and `1`, if violations were found, 
+> you could also use it in the CI of your LaTeX projects. 
+
+### Advanced: Custom Rulesets
+
+> [!warning]
+> Custom rulesets are plain Python code and will be executed on your machine.
+> If you wouldn't trust running `python3 my_rules.py`, you shouldn't use it with `bibtex_linter`.
+> **Only use rulesets from sources you trust!**
+
+It is also possible to define your own rules inside a Python file. 
+Let's call it `my_own_rules.py`.
+Creating your own rule is as simple as:
+
+```Python
+from typing import List
+
+from bibtex_linter.parser import BibTeXEntry, EntryType
+from bibtex_linter.verification import linter_rule
+
+
+@linter_rule(entry_type=EntryType.ARTICLE)
+def check_article(entry: BibTeXEntry) -> List[str]:
+    """
+    Check that a `BibTeXEntry` has a nonempty `author` field.
+
+    :param entry: The BibTeXEntry
+    :return: A list of string descriptions of rule violations for this entry.
+    """
+    if not entry.fields.get("author"):
+        return [f"Entry '{entry.name}' misses the required field author!"]
+    return []
+```
+
+As you can see, we created a method and designated that it is a linter rule by using the `@linter_rule` decorator.
+The method needs to have a specific interface: 
+It needs to take the `BibTeXEntry` to be checked as input argument, and it needs to return a List of strings explaining
+the rule violations for that `BibTeXEntry`. 
+If there are no rule violations, it should return an empty list. 
+
+This rule only gets executed for entries of the `ARTICLE` type, as specified by the decorator argument.
+If we left the `entry_type` argument empty, this check would be executed on all entries.
+
+For more inspiration on what you could define as your custom rules, have a look into `bibtex_linter/default_rules.py`.
+After defining the rules in `my_own_rules.py`, we can execute them on a BibTeX file like this: 
+
+```commandline
+bibtex_linter path/to/refs.bib path/to/my_own_rules.py
+```
+
+Let's reiterate the warning from beforehand:
+
+> [!warning]
+> Custom rulesets are plain Python code and will be executed on your machine.
+> If you wouldn't trust running `python3 my_rules.py`, you shouldn't use it with `bibtex_linter`.
+> **Only use rulesets from sources you trust!**
+
+
+## Definition of used Terms
+If you're unfamiliar with BibTex, here's a short list of terms, so that you can better understand the output of the
+`bibtex_linter`.
+
+### Entry
+An entry to the BibTeX file:
+```LaTeX
+@article{basic_case,
+  author = {Test author},
+  title = {Standard field format},
+  year = {2020}
+}
+```
+
+### Field
+A field inside an entry, consists of a `key` and a `value`:
+```LaTeX
+author = {Test author},
+```
+In this case, `"author"` would be the `key` and `"Test author"` the `value`. 
+
+> [!note]
+> There are many different ways of wrapping the value text, from `{}` via `{{}}` or `""`.
+> This tool removes these wrapping characters and only considers the text inside of them as `value`.
+
+### Entry Type
+The entry type specifies the available fields and is written behind the `@` and in front of the first `{` of an entry:
+```LaTeX
+@article{...}
+@conference{...}
+@online{...}
+```