swh.indexer.citation package

Submodules:

• swh.indexer.citation.bibtex module
  • BibTeXWithMacroWriter
    • BibTeXWithMacroWriter.quote()
  • codemeta_person_to_pybtex_person()
  • codemeta_data_to_bibtex()
• swh.indexer.citation.codemeta_data module
  • TMP_ROOT_URI_PREFIX
  • CodeMetaData
    • CodeMetaData.id
    • CodeMetaData.swhid
    • CodeMetaData.address
    • CodeMetaData.affiliation
    • CodeMetaData.applicationCategory
    • CodeMetaData.applicationSubCategory
    • CodeMetaData.author
    • CodeMetaData.buildInstructions
    • CodeMetaData.citation
    • CodeMetaData.codeRepository
    • CodeMetaData.continuousIntegration
    • CodeMetaData.contributor
    • CodeMetaData.copyrightHolder
    • CodeMetaData.copyrightYear
    • CodeMetaData.dateCreated
    • CodeMetaData.dateModified
    • CodeMetaData.datePublished
    • CodeMetaData.description
    • CodeMetaData.developmentStatus
    • CodeMetaData.downloadUrl
    • CodeMetaData.editor
    • CodeMetaData.email
    • CodeMetaData.embargoEndDate
    • CodeMetaData.encoding
    • CodeMetaData.endDate
    • CodeMetaData.familyName
    • CodeMetaData.fileFormat
    • CodeMetaData.fileSize
    • CodeMetaData.funder
    • CodeMetaData.funding
    • CodeMetaData.givenName
    • CodeMetaData.hasPart
    • CodeMetaData.hasSourceCode
    • CodeMetaData.identifier
    • CodeMetaData.installUrl
    • CodeMetaData.isAccessibleForFree
    • CodeMetaData.isPartOf
    • CodeMetaData.isSourceCodeOf
    • CodeMetaData.issueTracker
    • CodeMetaData.keywords
    • CodeMetaData.license
    • CodeMetaData.maintainer
    • CodeMetaData.memoryRequirements
    • CodeMetaData.name
    • CodeMetaData.operatingSystem
    • CodeMetaData.permissions
    • CodeMetaData.position
    • CodeMetaData.processorRequirements
    • CodeMetaData.producer
    • CodeMetaData.programmingLanguage
    • CodeMetaData.provider
    • CodeMetaData.publisher
    • CodeMetaData.readme
    • CodeMetaData.referencePublication
    • CodeMetaData.relatedLink
    • CodeMetaData.releaseNotes
    • CodeMetaData.review
    • CodeMetaData.reviewAspect
    • CodeMetaData.reviewBody
    • CodeMetaData.roleName
    • CodeMetaData.runtimePlatform
    • CodeMetaData.sameAs
    • CodeMetaData.softwareHelp
    • CodeMetaData.softwareRequirements
    • CodeMetaData.softwareSuggestions
    • CodeMetaData.softwareVersion
    • CodeMetaData.sponsor
    • CodeMetaData.startDate
    • CodeMetaData.storageRequirements
    • CodeMetaData.supportingData
    • CodeMetaData.targetProduct
    • CodeMetaData.url
    • CodeMetaData.version
  • CodeMetaPerson
    • CodeMetaPerson.names
    • CodeMetaPerson.given_names
    • CodeMetaPerson.family_names
    • CodeMetaPerson.is_organization
  • rdf_str_values()
  • rdf_first_str_value()
  • extract_person()
  • resolve_role_nodes()
  • extract_people()
  • extract_rdf_metadata()
  • extract_compact_identifiers()
  • merge_identifiers()
  • normalize_doc_id()
  • extract_codemeta_data()
• swh.indexer.citation.csl module
  • codemeta_person_to_csl()
  • codemeta_data_to_csl()
• swh.indexer.citation.exceptions module
  • CitationError

Module contents:

class swh.indexer.citation.CitationFormat(value)

Bases: Enum

BIBTEX = 'BibTeX'

CSL = 'CSL JSON'

swh.indexer.citation.codemeta_to_citation(doc: Dict[str, Any], format: CitationFormat, swhid: QualifiedSWHID | None = None, force_codemeta_context: bool = False, resolve_unknown_context_url: bool = False) → str

Generate a citation from a parsed codemeta.json file.

Parameters:

• doc – parsed codemeta.json file

• format – citation format to generate

• swhid – optional SWHID to embed in the citation

• force_codemeta_context – if True, the @context field in the JSON-LD document will be set to the CodeMeta v3.0 one, this can be used to ensure citation can be generated when strict JSON-LD parsing failed

• resolve_unknown_context_url – if const:True unknown JSON-LD context URL will be fetched using requests instead of raising an exception, False by default as it can lead sending requests to arbitrary URLs so use with caution

Returns:

A citation string in the requested format.

Raises:

CitationError – when citation could not be generated