Project Information
===================

This final section provides supplementary information about the
``bib-ami`` project, including its software dependencies, guidance on
how to cite the tool in your own work, and details on contributing.

Dependencies
------------

The ``bib-ami`` tool relies on a small set of well-maintained,
open-source Python packages. These will be installed automatically when
you install ``bib-ami`` via ``pip``.

``bibtexparser``
   For robust parsing and writing of BibTeX files.

``requests``
   For handling all HTTP requests to the CrossRef API.

``fuzzywuzzy``
   For performing the fuzzy string matching required for deduplication.

``python-Levenshtein``
   An optional but highly recommended C-based library that significantly
   speeds up the string similarity calculations used by ``fuzzywuzzy``.

How to Cite bib-ami
-------------------

If you use ``bib-ami`` in your research workflow and would like to cite
it, please use the following BibTeX entry. Citing software helps the
developers and maintainers justify their work and secure funding for
future development.

::

   @misc{bib_ami_2024,
     author       = {Rolf Carlson},
     title        = {bib-ami: A BibTeX Integrity Manager},
     year         = {2025},
     publisher    = {GitHub},
     url          = {https://github.com/hrolfrc/bib-ami},
     doi          = {10.5281/zenodo.15795718}
   }

Contributing & License
----------------------

Contributing
~~~~~~~~~~~~

This project is open source and contributions are welcome. If you would
like to contribute, please visit the project’s GitHub repository. You
can contribute by reporting bugs, suggesting new features, or submitting
pull requests with code improvements. Please consult the
``CONTRIBUTING.md`` file in the repository for specific guidelines.

License
~~~~~~~

The ``bib-ami`` tool is distributed under the MIT License. This is a
permissive open-source license that allows for broad use, modification,
and distribution. Please see the ``LICENSE`` file in the source
repository for the full text of the license.