Metadata-Version: 2.4
Name: As-A-Person
Version: 0.1.2
Summary: A simple Python library for converting URLs to citable people
Author-email: Ryan Quinn <ryan.quinn@certusinnovations.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Stonewall-Defense/asaperson
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests==2.32.5
Requires-Dist: xmltodict==1.0.0
Requires-Dist: PyContactFile==0.3.2
Dynamic: license-file

# As-A-Person: A simple Python library for converting URLs to citable people

Supports ORCID, ISNI, [vCard](https://www.rfc-editor.org/rfc/rfc6350), [hCard](https://microformats.org/wiki/hcard), and [jCard](https://www.rfc-editor.org/rfc/rfc7095) lookup and parsing. Everything is converted to the internal `CitablePerson` dataclass.

## Motivation

Various metadata fromats, including [DataCite](https://datacite-metadata-schema.readthedocs.io/en/4.6/properties/creator/) and [Frictionless](https://datapackage.org/standard/data-package/#contributors) require similar, but not identical, metadata for authors. Neither adheres to a particular standard nor supplies tools for resulving author URIs.

## Prerequisites

- Python 3.11 runtime
- Pip for package installation

## Installation

Install the dependencies into the environment with [pip](https://pypi.org/project/pip/):

```bash
pip install -r requirements.txt
pip install .
```

## Usage

Feed identifiers into the appropriate dereferencing function, e.g., `orcid_to_person` for an ORCID, to return a `CitablePerson` on success or raise a `ValueError` on failure.

## Testing

```bash
python3 -m coverage run -m unittest discover -s test -p "*_test.py" && python -m coverage report --skip-covered
python -m coverage html
```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Stonewall-Defense/asaperson/tags).

## Authors

- **Ryan Quinn** - _Initial work_

## License

MIT.
