https://github.com/caltechlibrary/convert_codemeta
Convert and validate codemeta files using crosswalk
https://github.com/caltechlibrary/convert_codemeta
Last synced: 10 months ago
JSON representation
Convert and validate codemeta files using crosswalk
- Host: GitHub
- URL: https://github.com/caltechlibrary/convert_codemeta
- Owner: caltechlibrary
- License: other
- Created: 2019-10-28T18:31:33.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2020-12-09T23:56:05.000Z (over 5 years ago)
- Last Synced: 2024-12-08T23:10:24.067Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 135 KB
- Stars: 3
- Watchers: 9
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Convert Codemeta
=====================================================
Will be replaced by improved crosswalks and https://github.com/SciCodes/somef-core
Python utility for converting and validating codemeta.json files using the codemeta crosswalk
[](https://choosealicense.com/licenses/bsd-3-clause)
[](http://shields.io)
Table of contents
-----------------
* [Introduction](#introduction)
* [Installation](#installation)
* [Usage](#usage)
* [Known issues and limitations](#known-issues-and-limitations)
* [Getting help](#getting-help)
* [Contributing](#contributing)
* [License](#license)
* [Authors and history](#authors-and-history)
* [Acknowledgments](#authors-and-acknowledgments)
Introduction
------------
This application copies some functionality of
[codemetar](https://github.com/ropensci/codemetar), but in python. It includes
codemeta validation and crosswalk functions.
Installation
------------
Clone from github
Type `pip install .`
Usage
-----
Validate codemeta in a python script: `validate_codemeta(codemeta)`
Convert to codemeta in a python script by providing the input format:
`crosswalk(data, "bio.tools")`
Convert from codemeta to a different format in a python script by providing both formats:
`crosswalk(data, "codemeta", "Zenodo")`
Run tests by typing `pytest tests`
Known issues and limitations
----------------------------
In active development
Getting help
------------
Submit issues on GitHub, or send me a note at tmorrell@caltech.edu
Contributing
------------
Contributions are welcome! See [Contributing](CONTRIBUTING) for more details.
License
-------
Software produced by the Caltech Library is Copyright (C) 2019, Caltech. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.
Authors and history
---------------------------
Tom Morrell
Acknowledgments
---------------
This work was funded by the [Alfred P. Sloan Foundation](https://sloan.org/) as
part of the [2019 Scientific Software Registry Collaboration
Workshop](http://asclnet.github.io/SWRegistryWorkshop). It is maintained by the California Institute of Technology Library.
