Metadata-Version: 2.2
Name: updateCitation
Version: 0.0.1
Summary: Automatically update citation files (CITATION.cff) in a GitHub repository from `pyproject.toml`, GitHub releases, and PyPI releases.
Author-email: Hunter Hogan <HunterHogan@pm.me>
License: CC-BY-NC-4.0
Project-URL: Donate, https://www.patreon.com/integrated
Project-URL: Homepage, https://github.com/hunterhogan/updateCitation
Project-URL: Repository, https://github.com/hunterhogan/updateCitation.git
Keywords: citation,cff,doi,github,zenodo
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: cffconvert
Requires-Dist: httpx
Requires-Dist: packaging
Requires-Dist: pygithub
Requires-Dist: ruamel.yaml
Requires-Dist: tomli
Provides-Extra: testing
Requires-Dist: pytest-cov; extra == "testing"
Requires-Dist: pytest-xdist; extra == "testing"
Requires-Dist: pytest; extra == "testing"

# updateCitation

A tool to automatically update citation files (CITATION.cff) in a repository based on metadata from `pyproject.toml`, GitHub releases, and PyPI releases.

## Features

- Automatically updates `CITATION.cff` files.
- Extracts metadata from `pyproject.toml`.
- Retrieves release information from GitHub.
- Fetches package information from PyPI.
- Ensures citation files are up-to-date with the latest project information.

## Installation

```bash
pip install updateCitation
```

## Usage

Run `updateCitation` from the root of your repository:

```python
from updateCitation import updateHere
updateHere(path/to/repo)
```

This will:

1. Read the `pyproject.toml` file for project metadata.
2. Fetch the latest release information from GitHub.
3. Retrieve package information from PyPI.
4. Update the `CITATION.cff` file in your repository.

## Configuration

Configuration is managed through the `pyproject.toml` file. Ensure that the `[project]` section contains accurate and up-to-date information about your project, including:

- `name`: The name of the package.
- `version`: The current version of the package.
- `authors`: A list of authors and their associated email addresses.
- `description`: A short description of the package.
- `keywords`: A list of keywords associated with the package.
- `license`: The license information for the package.
- `urls`: Links to the project homepage, repository, and other relevant URLs.

[![CC-BY-NC-4.0](https://github.com/hunterhogan/updateCitation/blob/main/CC-BY-NC-4.0.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
