bib-ami 0.0.1__tar.gz

bib-ami-0.0.1/LICENSE

@@ -0,0 +1,23 @@
+### 5. License: `LICENSE`
+```text
+MIT License
+
+Copyright (c) 2025 Rolf Carlson
+
+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.

bib-ami-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

bib-ami-0.0.1/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: bib-ami
+Version: 0.0.1
+Summary: A tool to merge and clean BibTeX files.
+Home-page: https://github.com/hrolfrc/bib-ami
+Author: Rolf Carlson
+Author-email: hrolfrc@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# bib-ami
+
+A Python tool to merge and clean BibTeX files. Currently, it consolidates all `.bib` files from a directory into a single output file. Future versions will include deduplication, DOI validation, and metadata refreshing.
+
+## Installation
+```bash
+pip install bib-ami

bib-ami-0.0.1/README.rst

@@ -0,0 +1,35 @@
+.. -*- mode: rst -*-
+
+|CircleCI|_ |ReadTheDocs|_
+
+.. |CircleCI| image:: https://circleci.com/gh/hrolfrc/bib-ami.svg?style=shield
+.. _CircleCI: https://circleci.com/gh/hrolfrc/bib-ami
+
+.. |ReadTheDocs| image:: https://readthedocs.org/projects/bib-ami/badge/?version=latest
+.. _ReadTheDocs: https://bib-ami.readthedocs.io/en/latest/?badge=latest
+
+BibClean
+#####################################
+
+Clean and update your bibtex .bib files
+
+Contact
+------------------
+Rolf Carlson hrolfrc@gmail.com
+
+Install
+------------------
+Use pip to install calfcv.
+
+``pip install bib-ami``
+
+Introduction
+------------------
+This is the bib-ami project.
+
+Example
+===========
+
+.. code:: ipython2
+
+    from bib-ami import bib_ami

bib-ami-0.0.1/bib_ami/__init__.py

@@ -0,0 +1 @@
+

bib-ami-0.0.1/bib_ami/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

bib-ami-0.0.1/bib_ami/bib_ami.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+"""bib_ami: A tool to consolidate and clean BibTeX files.
+
+This script merges all .bib files from a specified directory into a single output file.
+Future versions will include deduplication, DOI validation, and metadata refreshing.
+"""
+
+import argparse
+import logging
+from pathlib import Path
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(levelname)s - %(message)s",
+    handlers=[logging.StreamHandler()]
+)
+logger = logging.getLogger(__name__)
+
+
+def merge_bib_files(input_dir: str, output_file: str) -> None:
+    """Merge all .bib files from input_dir into a single output_file.
+
+    Args:
+        input_dir (str): Directory containing .bib files.
+        output_file (str): Path to the output .bib file.
+    """
+    input_path = Path(input_dir)
+    output_path = Path(output_file)
+
+    # Validate input directory
+    if not input_path.is_dir():
+        logger.error(f"Input directory '{input_dir}' does not exist or is not a directory.")
+        raise ValueError(f"Invalid input directory: {input_dir}")
+
+    # Find all .bib files
+    bib_files = list(input_path.glob("*.bib"))
+    if not bib_files:
+        logger.warning(f"No .bib files found in '{input_dir}'.")
+        return
+
+    logger.info(f"Found {len(bib_files)} .bib files in '{input_dir}'.")
+
+    # Merge files into output
+    with output_path.open("w", encoding="utf-8") as outfile:
+        for bib_file in bib_files:
+            logger.info(f"Processing '{bib_file}'...")
+            try:
+                with bib_file.open("r", encoding="utf-8") as infile:
+                    content = infile.read()
+                    outfile.write(content)
+                    # Ensure a newline between files to avoid concatenation issues
+                    outfile.write("\n\n")
+            except Exception as e:
+                logger.error(f"Failed to read '{bib_file}': {e}")
+                continue
+
+    logger.info(f"Successfully merged {len(bib_files)} files into '{output_file}'.")
+
+
+# Placeholder for future functionality (commented out)
+"""
+def deduplicate_bibtex(input_file: str) -> None:
+    # Placeholder for deduplication using bibtexparser
+    # Requires: pip install bibtexparser
+    pass
+
+def validate_dois(input_file: str) -> None:
+    # Placeholder for DOI validation using CrossRef/DataCite APIs
+    # Requires: pip install requests
+    pass
+
+def refresh_metadata(input_file: str, output_file: str) -> None:
+    # Placeholder for refreshing BibTeX metadata with API data
+    # Requires: pip install requests bibtexparser
+    pass
+"""
+
+
+def main():
+    """Parse command-line arguments and run bib-ami."""
+    parser = argparse.ArgumentParser(
+        description="Merge BibTeX files from a directory into a single file."
+    )
+    parser.add_argument(
+        "--input-dir",
+        default=".",
+        help="Directory containing .bib files (default: current directory)."
+    )
+    parser.add_argument(
+        "--output-file",
+        default="output.bib",
+        help="Output file for merged BibTeX entries (default: output.bib)."
+    )
+    args = parser.parse_args()
+
+    try:
+        merge_bib_files(args.input_dir, args.output_file)
+    except Exception as e:
+        logger.error(f"Error during execution: {e}")
+        raise
+
+
+if __name__ == "__main__":
+    main()

bib-ami-0.0.1/bib_ami.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: bib-ami
+Version: 0.0.1
+Summary: A tool to merge and clean BibTeX files.
+Home-page: https://github.com/hrolfrc/bib-ami
+Author: Rolf Carlson
+Author-email: hrolfrc@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# bib-ami
+
+A Python tool to merge and clean BibTeX files. Currently, it consolidates all `.bib` files from a directory into a single output file. Future versions will include deduplication, DOI validation, and metadata refreshing.
+
+## Installation
+```bash
+pip install bib-ami

bib-ami-0.0.1/bib_ami.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+MANIFEST.in
+README.rst
+requirements.txt
+setup.cfg
+setup.py
+bib_ami/__init__.py
+bib_ami/_version.py
+bib_ami/bib_ami.py
+bib_ami.egg-info/PKG-INFO
+bib_ami.egg-info/SOURCES.txt
+bib_ami.egg-info/dependency_links.txt
+bib_ami.egg-info/entry_points.txt
+bib_ami.egg-info/top_level.txt
+tests/__init__.py
+tests/test_bib_ami.py

bib-ami-0.0.1/bib_ami.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bib-ami-0.0.1/bib_ami.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bib-ami = bib_ami.bib_ami:main

bib-ami-0.0.1/bib_ami.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+bib_ami
+tests

bib-ami-0.0.1/requirements.txt

@@ -0,0 +1,5 @@
+pytest>=7.4.0
+pytest-cov>=4.1.0
+twine>=4.0.2
+sphinx>=7.0.0
+sphinx_rtd_theme>=1.3.0

bib-ami-0.0.1/setup.cfg

@@ -0,0 +1,13 @@
+[metadata]
+description-file = README.rst
+
+[aliases]
+test = pytest
+
+[tool:pytest]
+addopts = --doctest-modules
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

bib-ami-0.0.1/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="bib-ami",
+    version="0.0.1",
+    packages=find_packages(),
+    install_requires=[],
+    entry_points={
+        "console_scripts": [
+            "bib-ami = bib_ami.bib_ami:main",
+        ],
+    },
+    author="Rolf Carlson",
+    author_email="hrolfrc@gmail.com",
+    description="A tool to merge and clean BibTeX files.",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/hrolfrc/bib-ami",
+    license="MIT",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.7",
+)

bib-ami-0.0.1/tests/test_bib_ami.py

@@ -0,0 +1,38 @@
+import tempfile
+from pathlib import Path
+
+from bib_ami.bib_ami import merge_bib_files
+
+
+# noinspection SpellCheckingInspection
+def test_merge_bib_files():
+    # Create temporary directory and test .bib files
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        # Create two sample .bib files
+        bib1 = Path(tmpdirname) / "test1.bib"
+        bib2 = Path(tmpdirname) / "test2.bib"
+        output = Path(tmpdirname) / "output.bib"
+
+        with bib1.open("w", encoding="utf-8") as f:
+            f.write("@article{test1, title={Test 1}}\n")
+        with bib2.open("w", encoding="utf-8") as f:
+            f.write("@article{test2, title={Test 2}}\n")
+
+        # Run merge
+        merge_bib_files(tmpdirname, str(output))
+
+        # Check output file exists and contains both entries
+        assert output.exists()
+        with output.open("r", encoding="utf-8") as f:
+            content = f.read()
+            assert "@article{test1" in content
+            assert "@article{test2" in content
+
+
+# noinspection SpellCheckingInspection
+def test_merge_bib_files_no_bib_files():
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        output = Path(tmpdirname) / "output.bib"
+        merge_bib_files(tmpdirname, str(output))
+        # Should not fail, just log a warning
+        assert not output.exists()