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
    • get_license_classifier()
    • get_pypi_url()
    • get_version()
    • update_pyproject_toml()
  • prometa.python.venv module
    • VirtualEnvironment
      • VirtualEnvironment.__init__()
      • VirtualEnvironment.run_cmd()
      • VirtualEnvironment.run_cmd_in_venv()
      • VirtualEnvironment.run_pip_in_venv()
      • VirtualEnvironment.run_python_in_venv()
      • VirtualEnvironment.sys_exe
      • VirtualEnvironment.uv_path
  • 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

Configuration.

class prometa.config.Config(proj_path, custom_config_paths=None, use_xdg=True, **overrides)

Bases: object

Common non-derivable configuration.

__init__(proj_path, custom_config_paths=None, use_xdg=True, **overrides)

Parameters:

• proj_path – The project path.

• custom_config_paths – An iterable over custon configuration file paths to use in addition to the standard configuration files that Prometa normally detects.

• use_xdg – If True, search for configuration files in standard XDG configuration directories. These files will be given the lowest priority.

• **overrides – Custom run-time overrides that take precedence over values in all discovered configuration files.

property config

The configuration file object. If None, there is no configuration file.

Raises:

ConfigError – One of the configuration files failed to load.

property config_paths

A generator over existing configuration paths. It is a wrapper around possible_config_paths that checks for and logs existence.

get(*keys, default=None)

Retrieve a configuration file value. This will scan the loaded configuration files in order and return the first match.

Parameters:

• *keys – The keys to the field. For example, to retrieve the value of “bar” under “foo”, call get(“foo”, “bar”). Integers may also be used to index lists.

• default – The default value to return if no value was found.

Returns:

The target value, or the default if no value was found.

property gitlab

The python-gitlab GitLab instance from the current configuration.

property possible_config_paths

A generator over the possible configuration file paths. Custom paths are yielded first, in the order they were given. Next the possible visible and hidden configuration paths in the current project directory and all of its parent directories are yielded, starting with the project directory and moving up to the root directory. Finally, if use_xdg is True, the standard XDG configuration directories are yielded, again in the standard order.

The generator does not check if the paths exist but it will omit duplicate paths.

exception prometa.config.ConfigError

Bases: PrometaException

Custom error raised by the Config class.

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

Update project metadata.

prometa.main.main(args=None)

Main function.

prometa.main.run_main(args=None)

Wrapper around main for exception handling.

prometa.project module

Project class.

class prometa.project.Project(path, **config_kwargs)

Bases: object

Project class.

__init__(path, **config_kwargs)

Parameters:

• path – The path to the project.

• **config_kwargs – Keyword arguments passed through to Config.

property citation_cff_path

The path to the CITATION.cff file.

property codemeta_json_path

The path to the codemeta.json file.

property license_txt_path

The path to the LICENSE.txt file.

property name

The project name. It will use the value in codemeta.name if it exists, otherwise it will use the name of the project’s directory.

property pyproject_toml_path

The pyproject.toml path.

property readme_md_path

The README.md path.

property spdx_license

The detected SPDX license name.

update()

Update project metadata.

property urls

A dict of URLs for the project.

prometa.readme module

Insert data into the README.

class prometa.readme.ReadmeInserter(project)

Bases: MarkdownInserter

Insert data into the Markdown file.

__init__(project)

Parameters:

regex – A compiled regular expression.

get_output(label, content)

Override parent get_output.

prometa.requests module

Convenience functions for the requests package.

prometa.requests.get_json_or_none(url, timeout=5)

Request a URL and return either the JSON response or None if the request failed. An error message will be logged in the latter case.

Parameters:

url – The URL to request. It should return a JSON response.

Returns:

The parsed JSON object, or None if the request failed.

Module contents

Package stub.