Zenodo DOI and badges

Author: pgarrett-scripps

CHANGELOG.md

@@ -27,6 +27,8 @@ All notable changes to this project will be documented in this file.
 - added simple fasta_parser since I kept recreating it in other projects, works with several input types
 - some more tests
 - added condense_to_mass_mods to mass_calc.py which condenses modifications to a single +/- mass value
+- Fixed Docs
+- Linting
 
 ## [2.0.0]
 ### Added:

README.md

@@ -1,10 +1,16 @@
 
+
 # Peptacular
 
+[![DOI](https://zenodo.org/badge/591504879.svg)](https://doi.org/10.5281/zenodo.15054278)[![Python package](https://github.com/pgarrett-scripps/peptacular/actions/workflows/python-package.yml/badge.svg)](https://github.com/pgarrett-scripps/peptacular/actions/workflows/python-package.yml)[![Pylint](https://github.com/pgarrett-scripps/peptacular/actions/workflows/pylint.yml/badge.svg)](https://github.com/pgarrett-scripps/peptacular/actions/workflows/pylint.yml)
+
+
 **peptacular** is an extremely lightweight package with only one dependency: ``regex``.
 
 It contains functions for parsing and working with Proforma2.0 compliant peptide & protein sequences.
 
+If you use **peptacular** in your research, please cite: https://doi.org/10.5281/zenodo.15054278
+
 ## Documentation
 https://peptacular.readthedocs.io/en/latest/
 

docs/source/index.rst

@@ -6,22 +6,14 @@
 Welcome to peptacular's documentation!
 ======================================
 
-Peptacular is a Python library for peptide-related bioinformatics. It provides tools for:
+If you use **peptacular** in your research, please cite:
 
-* Peptide mass calculations
-* Enzymatic digestion
-* Spectral matching and scoring
-* Glycan and modification handling
-* Sequence manipulation and more
+.. image:: https://zenodo.org/badge/591504879.svg
+  :target: https://doi.org/10.5281/zenodo.15054278
 
-The library is designed to be easy to use, with all functions available directly from the main package:
+**peptacular** is an extremely lightweight package with only one dependency: ``regex``.
 
-.. code-block:: python
-
-   import peptacular as pt
-   
-   # Calculate the mass of a peptide
-   mass = pt.mass("PEPTIDE")
+It contains functions for parsing and working with Proforma2.0 compliant peptide & protein sequences.
 
 .. toctree::
    :maxdepth: 2