A module to synchronize metadata between TOML and CFF files, including between pyproject.toml and CITATION.cff files.
Project description
cff2toml
A module to synchronize metadata between TOML and CFF files, including between pyproject.toml and CITATION.cff files.
Table of Contents
Installation
pip install cff2toml
Usage
Updating pyproject.toml with metadata from CITATION.cff
from cff2toml import update_pyproject_toml_with_citation_cff
# update pyproject.toml with metadata
# from CITATION.cff
# where both files are located in the working directory
update_pyproject_toml_with_citation_cff()
from cff2toml import update_pyproject_toml_with_citation_cff
import os
# update pyproject.toml with metadata
# from CITATION.cff
# with custom file paths
pyproject_toml_file_path: str = os.path.join('somepath', 'pyproject.toml')
citation_cff_file_path: str = os.path.join('someotherpath', 'CITATION.cff')
update_pyproject_toml_with_citation_cff(pyproject_toml_file_path=pyproject_toml_file_path, citation_cff_file_path=citation_cff_file_path)
Updating CITATION.cff with metadata from pyprojects.toml
from cff2toml import update_citation_cff_with_pyproject_toml
# update CITATION.cff with metadata
# from pyprojects.cff
# where both files are located in the working directory
update_citation_cff_with_pyproject_toml()
from cff2toml import update_citation_cff_with_pyproject_toml
import os
# update CITATION.cff with metadata
# from pyprojects.cff
# with custom file paths
pyproject_toml_file_path: str = os.path.join('somepath', 'pyproject.toml')
citation_cff_file_path: str = os.path.join('someotherpath', 'CITATION.cff')
update_citation_cff_with_pyproject_toml(citation_cff_file_path=citation_cff_file_path, pyproject_toml_file_path=pyproject_toml_file_path)
Setting the same version for both the pyprojects.toml file and CITATION.cff file
from cff2toml import set_version_for_pyproject_toml_and_citation_cff
# set same version for pyproject.toml
# and CITATION.cff where both files are
# located in the working directory
set_version_for_pyproject_toml_and_citation_cff(version="2.0.0")
from cff2toml import set_version_for_pyproject_toml_and_citation_cff
import os
# set same version for pyproject.toml
# and CITATION.cff where both files
# have custom file paths
pyproject_toml_file_path: str = os.path.join('somepath', 'pyproject.toml')
citation_cff_file_path: str = os.path.join('someotherpath', 'CITATION.cff')
set_version_for_pyproject_toml_with_citation_cff(version="2.0.0", pyproject_toml_file_path=pyproject_toml_file_path, citation_cff_file_path=citation_cff_file_path)
Updating TOML file with metadata from CFF file
from cff2toml import update_toml_with_cff, CFFObject, TOMLObject
import os
toml_file_path: str = os.path.join('somepath', 'some_toml_file.toml')
cff_file_path: str = os.path.join('somepath', 'some_cff_file.cff')
def transformer(toml_object:TOMLObject, cff_object:CFFObject) -> TOMLObject:
toml_object['somekey'] = cff_object['someotherkey']
return toml_object
updated_toml_object: TOMLObject = update_toml_with_cff(toml_file_path=toml_file_path, cff_file_path=cff_file_path, transform_toml_object_func=transformer)
Updating CFF file with metadata from TOML file
from cff2toml import update_cff_with_toml, CFFObject, TOMLObject
import os
toml_file_path: str = os.path.join('somepath', 'some_toml_file.toml')
cff_file_path: str = os.path.join('somepath', 'some_cff_file.cff')
def transformer(cff_object:CFFObject, toml_object:TOMLObject) -> CFFObject:
cff_object['somekey'] = toml_object['someotherkey']
return cff_object
updated_cff_object: CFFObject = update_cff_with_toml(cff_file_path=cff_file_path, toml_file_path=toml_file_path, transform_cff_object_func=transformer)
Load TOML file object
from cff2toml import load_toml_object, TOMLObject
import os
toml_file_path: str = os.path.join('somepath', 'some_toml_file.toml')
toml_object: TOMLObject = load_toml_object(toml_file_path=toml_file_path)
print(toml_object['somekey'])
Save TOML file object
from cff2toml import load_toml_object, save_toml_object, TOMLObject
import os
toml_file_path: str = os.path.join('somepath', 'some_toml_file.toml')
toml_object: TOMLObject = load_toml_object(toml_file_path=toml_file_path)
print(toml_object['somekey'])
toml_object['somekey'] = 'somevalue'
save_toml_object(toml_object=toml_object, toml_file_path=toml_file_path)
Load CFF file object
from cff2toml import load_cff_object, CFFObject
import os
cff_file_path: str = os.path.join('somepath', 'some_cff_file.cff')
cff_object: CFFObject = load_cff_object(cff_file_path=cff_file_path)
print(cff_object['somekey'])
Save CFF file object
from cff2toml import load_cff_object, save_cff_object, CFFObject
import os
cff_file_path: str = os.path.join('somepath', 'some_cff_file.cff')
cff_object: CFFObject = load_cff_object(cff_file_path)
print(cff_object['somekey'])
cff_object['somekey'] = 'somevalue'
save_cff_object(cff_object=cff_object, cff_file_path=cff_file_path)
License
cff2toml
is distributed under the terms of the Apache 2.0 license
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cff2toml-1.1.1.tar.gz
(9.4 kB
view hashes)