bib-optimizer 0.4.1__tar.gz → 0.4.3__tar.gz

{bib_optimizer-0.4.1/src/bib_optimizer.egg-info → bib_optimizer-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bib_optimizer
-Version: 0.4.1
+Version: 0.4.3
 Summary: Clean and optimize bib file.
 Author-email: Ka Wa Yip <yipkawa@gmail.com>
 License: MIT License
@@ -37,10 +37,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bibtexparser>=1.4.3
+Requires-Dist: bibtexparser<2,>=1.4.3
 Provides-Extra: build
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
@@ -89,16 +90,58 @@ These input files will **remain unchanged**.
 Installation
 ------------
 
-It can be installed with `pip`, ideally by using a [virtual environment](https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment). Open up a terminal and install the package and the dependencies with:  
-  
+### Install from PyPI with pip
 
-    `pip install bib_optimizer`
+Create and activate a virtual environment, then install the latest release from PyPI:
 
-_or_
+```bash
+python -m venv .venv
 
-    `python -m pip install bib_optimizer`
+# Linux/macOS
+source .venv/bin/activate
+
+# Windows
+.venv\Scripts\activate
+
+python -m pip install --upgrade bib_optimizer
+```
+
+Alternatively, install the command in an isolated environment with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install bib_optimizer
+```
+
+After either installation method, the `bibopt` command is available in your terminal.
+
+### Install from source for development
+
+This repository uses uv for project and dependency management.
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/kwyip/bib_optimizer.git
+   cd bib_optimizer
+   ```
+
+2. **Install environment**
+
+   ```bash
+   # This creates the virtual environment and installs all dependencies
+   uv sync
+   ```
+
+3. **Activate environment**
+
+   ```bash
+   # Linux/MacOS
+   source .venv/bin/activate
+
+   # Windows
+   .venv\Scripts\activate
+   ```
 
-  
 _🐍 This requires Python 3.8 or newer versions_
 
 * * *
@@ -122,20 +165,33 @@ _🐍 This requires Python 3.8 or newer versions_
 
 You may test the installation using the sample input files (`sample_main.tex` and `sample_ref.bib`) located in the test folder.
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot" height="200"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot"  width="34.83%"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" width="43%" />
 
-_`sample_main.tex` and `sample_ref.bib`_
+`sample_main.tex` _and_ `sample_ref.bib`
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" width="43%" />
 
-_A sample `ref_opt.bib` after running `bibopt sample_main.tex sample_ref.bib ref_opt.bib`_
+_A sample_ `ref_opt.bib` _created after running_ `bibopt sample_main.tex sample_ref.bib ref_opt.bib`
 
 ---
-#### New feature (version 0.4)
+#### New feature (version 0.4.0)
 
 If the `main.tex` calls inputs from other `.tex` (e.g., with `\input{...}`), the newly generated `ref_opt.bib` will preserve the order of appearances in the `main.tex` with each inputted `.tex` as well. \
 (The dependent `.tex` files need to be placed in the same directory as `main.tex`.)
 
 ---
+#### New feature (version 0.4.1)
+
+On top of version 0.4, skip any `\input` `.tex` file if not found.
+
+---
+#### New feature/Fix (version 0.4.2)
+
+Added support for the `\include{...}` command in addition to `\input{...}`, fixing missing citations when a LaTeX project uses `\include` to split its content across files.
+
+---
+#### New feature/Fix (version 0.4.3)
+
+Added Python 3.14 support and constrained `bibtexparser` to the compatible 1.x release series, fixing `ModuleNotFoundError: No module named 'bibtexparser.bwriter'` during fresh installations.
 
-♥ Lastly executed on Python `3.10` on 2025-06-09.
+♥ Lastly executed on Python `3.14` on 2026-09-29.

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/README.md

@@ -35,16 +35,58 @@ These input files will **remain unchanged**.
 Installation
 ------------
 
-It can be installed with `pip`, ideally by using a [virtual environment](https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment). Open up a terminal and install the package and the dependencies with:  
-  
+### Install from PyPI with pip
 
-    `pip install bib_optimizer`
+Create and activate a virtual environment, then install the latest release from PyPI:
 
-_or_
+```bash
+python -m venv .venv
 
-    `python -m pip install bib_optimizer`
+# Linux/macOS
+source .venv/bin/activate
+
+# Windows
+.venv\Scripts\activate
+
+python -m pip install --upgrade bib_optimizer
+```
+
+Alternatively, install the command in an isolated environment with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install bib_optimizer
+```
+
+After either installation method, the `bibopt` command is available in your terminal.
+
+### Install from source for development
+
+This repository uses uv for project and dependency management.
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/kwyip/bib_optimizer.git
+   cd bib_optimizer
+   ```
+
+2. **Install environment**
+
+   ```bash
+   # This creates the virtual environment and installs all dependencies
+   uv sync
+   ```
+
+3. **Activate environment**
+
+   ```bash
+   # Linux/MacOS
+   source .venv/bin/activate
+
+   # Windows
+   .venv\Scripts\activate
+   ```
 
-  
 _🐍 This requires Python 3.8 or newer versions_
 
 * * *
@@ -68,20 +110,33 @@ _🐍 This requires Python 3.8 or newer versions_
 
 You may test the installation using the sample input files (`sample_main.tex` and `sample_ref.bib`) located in the test folder.
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot" height="200"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot"  width="34.83%"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" width="43%" />
 
-_`sample_main.tex` and `sample_ref.bib`_
+`sample_main.tex` _and_ `sample_ref.bib`
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" width="43%" />
 
-_A sample `ref_opt.bib` after running `bibopt sample_main.tex sample_ref.bib ref_opt.bib`_
+_A sample_ `ref_opt.bib` _created after running_ `bibopt sample_main.tex sample_ref.bib ref_opt.bib`
 
 ---
-#### New feature (version 0.4)
+#### New feature (version 0.4.0)
 
 If the `main.tex` calls inputs from other `.tex` (e.g., with `\input{...}`), the newly generated `ref_opt.bib` will preserve the order of appearances in the `main.tex` with each inputted `.tex` as well. \
 (The dependent `.tex` files need to be placed in the same directory as `main.tex`.)
 
 ---
+#### New feature (version 0.4.1)
+
+On top of version 0.4, skip any `\input` `.tex` file if not found.
+
+---
+#### New feature/Fix (version 0.4.2)
+
+Added support for the `\include{...}` command in addition to `\input{...}`, fixing missing citations when a LaTeX project uses `\include` to split its content across files.
+
+---
+#### New feature/Fix (version 0.4.3)
+
+Added Python 3.14 support and constrained `bibtexparser` to the compatible 1.x release series, fixing `ModuleNotFoundError: No module named 'bibtexparser.bwriter'` during fresh installations.
 
-♥ Lastly executed on Python `3.10` on 2025-06-09.
+♥ Lastly executed on Python `3.14` on 2026-09-29.

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bib_optimizer"
-version = "0.4.1"
+version = "0.4.3"
 description = "Clean and optimize bib file."
 authors = [
   { name="Ka Wa Yip", email="yipkawa@gmail.com" },
@@ -14,7 +14,7 @@ authors = [
 license = { file = "LICENSE" }
 readme = "README.md"
 requires-python = ">=3.8"
-dependencies = ["bibtexparser>=1.4.3"]
+dependencies = ["bibtexparser>=1.4.3,<2"]
 classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
@@ -24,7 +24,8 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13"
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14"
 ]
 keywords = ["latex", "bib", "bibliography"]
 
@@ -40,7 +41,7 @@ dev   = ["black", "bumpver", "isort", "mypy", "pytest"]
 bibopt = "bib_optimizer.__main__:main"
 
 [tool.bumpver]
-current_version = "0.4.1"
+current_version = "0.4.3"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message  = "bump version {old_version} -> {new_version}"
 commit          = true
@@ -61,5 +62,3 @@ import_heading_stdlib     = "Standard library imports"
 import_heading_thirdparty = "Third party imports"
 import_heading_firstparty = "Reader imports"
 
-
-

bib_optimizer-0.4.3/src/bib_optimizer/__init__.py

@@ -0,0 +1,2 @@
+# Version
+__version__ = "0.4.3"

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/src/bib_optimizer/__main__.py

@@ -1,7 +1,7 @@
 """Version:
 --------
 
-- bib_optimizer v0.4.1
+- bib_optimizer v0.4.3
 """
 import sys
 from bib_optimizer import helpers
@@ -21,4 +21,3 @@ if __name__ == '__main__':
 	main()
 
 
-

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/src/bib_optimizer/helpers.py

@@ -25,11 +25,11 @@ def bib_opt(filename, input_bib, output_bib):
     all_keys = []
     temp_citations = set()
     
-    split_pattern = r'(.*?)(\\input[^\n]*\n)(.*?)((?=\\input)|\Z)'
+    split_pattern = r'(.*?)(\\(?:input|include)[^\n]*\n)(.*?)((?=\\(?:input|include))|\Z)'
     matches = re.findall(split_pattern, filecontent, flags=re.DOTALL)
     split_results = [(before, after.strip()) for before, input_line, after, _ in matches]
     
-    input_pattern_extended = r'\\input\s*(?:{([^}]+)}|([^\s\n]+))'
+    input_pattern_extended = r'\\(?:input|include)\s*(?:{([^}]+)}|([^\s\n]+))'
     matches = re.findall(input_pattern_extended, filecontent)
     input_files_extended = [m[0] if m[0] else m[1] for m in matches]    
 

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3/src/bib_optimizer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bib_optimizer
-Version: 0.4.1
+Version: 0.4.3
 Summary: Clean and optimize bib file.
 Author-email: Ka Wa Yip <yipkawa@gmail.com>
 License: MIT License
@@ -37,10 +37,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bibtexparser>=1.4.3
+Requires-Dist: bibtexparser<2,>=1.4.3
 Provides-Extra: build
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
@@ -89,16 +90,58 @@ These input files will **remain unchanged**.
 Installation
 ------------
 
-It can be installed with `pip`, ideally by using a [virtual environment](https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment). Open up a terminal and install the package and the dependencies with:  
-  
+### Install from PyPI with pip
 
-    `pip install bib_optimizer`
+Create and activate a virtual environment, then install the latest release from PyPI:
 
-_or_
+```bash
+python -m venv .venv
 
-    `python -m pip install bib_optimizer`
+# Linux/macOS
+source .venv/bin/activate
+
+# Windows
+.venv\Scripts\activate
+
+python -m pip install --upgrade bib_optimizer
+```
+
+Alternatively, install the command in an isolated environment with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install bib_optimizer
+```
+
+After either installation method, the `bibopt` command is available in your terminal.
+
+### Install from source for development
+
+This repository uses uv for project and dependency management.
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/kwyip/bib_optimizer.git
+   cd bib_optimizer
+   ```
+
+2. **Install environment**
+
+   ```bash
+   # This creates the virtual environment and installs all dependencies
+   uv sync
+   ```
+
+3. **Activate environment**
+
+   ```bash
+   # Linux/MacOS
+   source .venv/bin/activate
+
+   # Windows
+   .venv\Scripts\activate
+   ```
 
-  
 _🐍 This requires Python 3.8 or newer versions_
 
 * * *
@@ -122,20 +165,33 @@ _🐍 This requires Python 3.8 or newer versions_
 
 You may test the installation using the sample input files (`sample_main.tex` and `sample_ref.bib`) located in the test folder.
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot" height="200"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_main_shot.png?raw=True" alt="sample_main_shot"  width="34.83%"/>&nbsp;&nbsp;<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_shot.png?raw=True" alt="sample_ref_shot" width="43%" />
 
-_`sample_main.tex` and `sample_ref.bib`_
+`sample_main.tex` _and_ `sample_ref.bib`
 
-<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" height="200" />
+<img src="https://github.com/kwyip/bib_optimizer/blob/main/sample_ref_opt_shot.png?raw=True" alt="sample_ref_opt_shot" width="43%" />
 
-_A sample `ref_opt.bib` after running `bibopt sample_main.tex sample_ref.bib ref_opt.bib`_
+_A sample_ `ref_opt.bib` _created after running_ `bibopt sample_main.tex sample_ref.bib ref_opt.bib`
 
 ---
-#### New feature (version 0.4)
+#### New feature (version 0.4.0)
 
 If the `main.tex` calls inputs from other `.tex` (e.g., with `\input{...}`), the newly generated `ref_opt.bib` will preserve the order of appearances in the `main.tex` with each inputted `.tex` as well. \
 (The dependent `.tex` files need to be placed in the same directory as `main.tex`.)
 
 ---
+#### New feature (version 0.4.1)
+
+On top of version 0.4, skip any `\input` `.tex` file if not found.
+
+---
+#### New feature/Fix (version 0.4.2)
+
+Added support for the `\include{...}` command in addition to `\input{...}`, fixing missing citations when a LaTeX project uses `\include` to split its content across files.
+
+---
+#### New feature/Fix (version 0.4.3)
+
+Added Python 3.14 support and constrained `bibtexparser` to the compatible 1.x release series, fixing `ModuleNotFoundError: No module named 'bibtexparser.bwriter'` during fresh installations.
 
-♥ Lastly executed on Python `3.10` on 2025-06-09.
+♥ Lastly executed on Python `3.14` on 2026-09-29.

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/src/bib_optimizer.egg-info/SOURCES.txt

@@ -1,11 +1,9 @@
 LICENSE
-MANIFEST.in
 README.md
 pyproject.toml
 src/bib_optimizer/__init__.py
 src/bib_optimizer/__main__.py
 src/bib_optimizer/helpers.py
-src/bib_optimizer/helpers_old.py
 src/bib_optimizer.egg-info/PKG-INFO
 src/bib_optimizer.egg-info/SOURCES.txt
 src/bib_optimizer.egg-info/dependency_links.txt

{bib_optimizer-0.4.1 → bib_optimizer-0.4.3}/src/bib_optimizer.egg-info/requires.txt

@@ -1,4 +1,4 @@
-bibtexparser>=1.4.3
+bibtexparser<2,>=1.4.3
 
 [build]
 build

bib_optimizer-0.4.1/src/bib_optimizer/__init__.py

@@ -1,2 +0,0 @@
-# Version
-__version__ = "0.4.1"

bib_optimizer-0.4.1/src/bib_optimizer/helpers_old.py

@@ -1,37 +0,0 @@
-import bibtexparser
-import re
-from bibtexparser.bwriter import BibTexWriter
-
-def bib_opt(filename, input_bib, output_bib):
-    with open(filename, 'r', encoding='utf-8') as file:
-        filecontent = file.read()
-
-    with open(input_bib, 'r', encoding='utf-8') as bibfile:
-        bib_database = bibtexparser.load(bibfile)
-
-    allowed_keys = []
-    all_keys = []
-    temp_citations = set()
-    
-    for e in re.findall(r'\\cite[tp]?\{([^}]+)\}', filecontent):
-        for c in e.split(','):  
-            c = c.strip()
-            if c not in temp_citations:
-                all_keys.append(c)
-                temp_citations.add(c)
-
-    for k in all_keys:
-        allowed_keys.append(k)
-
-    entry_dict = {entry.get('ID'): entry for entry in bib_database.entries}
-    filtered_entries = [entry_dict[key] for key in allowed_keys if key in entry_dict]
-
-    writer = BibTexWriter()
-    writer.indent = '    '  
-    writer.order_entries_by = None  
-
-    new_bib_database = bibtexparser.bibdatabase.BibDatabase()
-    new_bib_database.entries = filtered_entries
-
-    with open(output_bib, 'w', encoding='utf-8') as bibfile:
-        bibfile.write(writer.write(new_bib_database))