prometa package

Subpackages

• prometa.codemeta package
  • Submodules
  • prometa.codemeta.codemeta module
    • CodeMeta
      • CodeMeta.__init__()
      • CodeMeta.data
      • CodeMeta.load()
      • CodeMeta.modify_codemeta_data()
      • CodeMeta.name
      • CodeMeta.update()
      • CodeMeta.update_file()
    • CodeMetaError
  • prometa.codemeta.pyproject module
    • PyprojectCodeMeta
      • PyprojectCodeMeta.__init__()
      • PyprojectCodeMeta.modify_codemeta_data()
      • PyprojectCodeMeta.update()
  • Module contents
• prometa.gitlab package
  • Submodules
  • prometa.gitlab.ci module
    • GitlabCI
      • GitlabCI.__init__()
      • GitlabCI.add_register_pip_pkg()
      • GitlabCI.add_release_job()
      • GitlabCI.add_stages()
      • GitlabCI.add_tags()
      • GitlabCI.data
      • GitlabCI.load()
      • GitlabCI.manage_hooks()
      • GitlabCI.update()
      • GitlabCI.update_pages()
  • prometa.gitlab.repo module
    • GitlabRepo
      • GitlabRepo.__init__()
      • GitlabRepo.get_gitlab_project()
      • GitlabRepo.get_main_blob_url()
      • GitlabRepo.get_section_url()
      • GitlabRepo.parsed_origin
      • GitlabRepo.public_git_url
      • GitlabRepo.public_url
      • GitlabRepo.readme_url
      • GitlabRepo.remote_url
      • GitlabRepo.run_cmd()
      • GitlabRepo.top_level
  • Module contents
• prometa.id package
  • Submodules
  • prometa.id.hal module
    • get_hal_id_from_url()
    • get_hal_url_by_origin()
  • prometa.id.orcid module
    • get_orcid_url()
  • prometa.id.swh module
    • get_swh_url_by_origin()
    • get_swhid_by_origin()
    • swh_project_exists()
  • Module contents
• prometa.python package
  • Submodules
  • prometa.python.common module
  • prometa.python.venv module
    • VirtualEnvironment
      • VirtualEnvironment.__init__()
      • VirtualEnvironment.run_pip_in_venv()
      • VirtualEnvironment.run_python_in_venv()
      • VirtualEnvironment.sys_exe
  • Module contents

Submodules

prometa.citation module

Citation file format (.cff) functions.

https://citation-file-format.github.io/ https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

class prometa.citation.Citation(project)

Bases: object

Citation data manager.

__init__(project)

Parameters:

project – A Project instance.

static get_template()

Get the cff file template as an object.

update()

Update the citation file with data from codemeta.json and other sources.

Returns:

The citation file object.

prometa.common module

Common constants and functions.

prometa.common.choose(items, include_none=False)

Prompt the user to choose an item from an iterable of items.

Parameters:

• items – The iterable of items.

• include_none – If True, allow the user to choose None even if it is not in the list.

Returns:

The chosen item.

prometa.config module

prometa.exception module

Exceptions.

exception prometa.exception.PrometaException

Bases: Exception

Base class for custom exceptions.

prometa.file module

File operations.

prometa.file.diff(path_1, path_2, differ='vimdiff')

Diff 2 paths.

prometa.file.update_content(content, path, encoding='utf-8', **kwargs)

Interactively compare and merge new content. If the target path does not exist, the content will be written directly to it.

Parameters:

• content – The new content to merge.

• path – The target path.

• encoding – The file encoding to use when writing the content. If None, the content is assumed to be bytes.

• **kwargs – Keyword arguments passed through to diff().

prometa.insert module

Base class for inserting content into text files.

class prometa.insert.Inserter(regex)

Bases: object

Insert updated content into a text file.

__init__(regex)

Parameters:

regex – A compiled regular expression.

insert(match)

Given a regular expression match, return the content to insert.

Parameters:

match – The Match object.

Returns:

The string to substitute for the match.

update(path, encoding='utf-8')

Insert the configured content into the file.

class prometa.insert.MarkdownInserter

Bases: Inserter

Inserter with custom regex for invisible comments in Markdown files.

In Markdown, a link label for a simple hash results in no output for most common Markdown processors: “[comment]: #”. Note that these must be proceeded by blank lines to be recognized in Markdown.

This class recognized blocks that begin with a comment prefixed with “insert: “ and end with a comment containing only “/insert”. Both comments must have the same indentation level and the inserted text will be indented to the same level.

__init__()

Parameters:

regex – A compiled regular expression.

static get_link(label, url)

Get the Markdown link.

Parameters:

• label – The label shown for the link.

• url – The URL of the link.

Returns:

The Markdown link as a string.

get_output(label, content)

Get output to replace the given label. Override this to insert custom content.

Parameters:

• label – The label in the comment pair that was matched.

• content – The content between the matched comments.

Returns:

The content to insert, or None if the label was not recognized.

insert(match)

Given a regular expression match, return the content to insert.

Parameters:

match – The Match object.

Returns:

The string to substitute for the match.

prometa.main module

prometa.project module

prometa.readme module

Module contents

Package stub.