updateCitation is a Python tool that automates the maintenance of citation metadata in software projects. It helps researchers and developers ensure their work is properly citeable while maintaining consistent metadata across different platforms.
- Automatic generation and updates of CITATION.cff files
- Seamless integration with Python package metadata from pyproject.toml
- Synchronization with GitHub release information
- Integration with PyPI package metadata
- Validation of citation metadata format
- GitHub Actions support for automated updates
pip install updateCitationThe simplest way to use updateCitation is to run it from your repository root:
import updateCitation
updateCitation.here()For custom pyproject.toml locations:
updateCitation.here("path/to/pyproject.toml")updateCitation provides a GitHub Action that automatically updates your citation metadata on each push. To enable this:
- Create
.github/workflows/updateCitation.ymlin your repository - Copy the provided workflow configuration
- Commit and push to activate automated citation updates
updateCitation primarily uses your project's pyproject.toml file for configuration. Essential fields include:
name: Package nameversion: Current versionauthors: List of authors with names and emails
description: Project descriptionkeywords: Search keywordslicense: License informationurls: Project URLs (homepage, repository, etc.)
You can customize updateCitation's behavior in the [tool.updateCitation] section of pyproject.toml.
For detailed documentation, examples, and best practices, visit our GitHub repository.
Contributions are welcome! Please feel free to submit pull requests.
Coding One Step at a Time:
- WRITE CODE.
- Don't write stupid code that's hard to revise.
- Write good code.
- When revising, write better code.
