Index

_

__init__() (prometa.citation.Citation method) (prometa.codemeta.codemeta.CodeMeta method) (prometa.config.Config method) (prometa.git.GitHost method) (prometa.git.gitlab.api.GitLabAPI method) (prometa.git.gitlab.badges.badge_manager.BadgeManager method) (prometa.git.gitlab.badges.BadgeManager method) (prometa.git.gitlab.ci.ci_job_manager.CIJobManager method) (prometa.git.gitlab.ci.CIJobManager method) (prometa.git.gitlab.ci.GitLabCI method) (prometa.git.gitlab.hooks.hook_manager.HookManager method) (prometa.git.gitlab.hooks.HookManager method) (prometa.git.GitRepo method) (prometa.git.host.GitHost method) (prometa.git.repo.GitRepo method) (prometa.insert.Inserter method) (prometa.insert.MarkdownInserter method) (prometa.package.Package method) (prometa.package.package.Package method) (prometa.package.python.package.PythonPackage method) (prometa.project.Project method) (prometa.python.venv.VirtualEnvironment method) (prometa.readme.ReadmeInserter method)

A

add_stages() (prometa.git.gitlab.ci.GitLabCI method)

add_tags() (prometa.git.gitlab.ci.GitLabCI method)

B

BadgeManager (class in prometa.git.gitlab.badges) (class in prometa.git.gitlab.badges.badge_manager)

BlackBadgeManager (class in prometa.git.gitlab.badges.python.black)

C

choose() (in module prometa.utils) CIJobManager (class in prometa.git.gitlab.ci) (class in prometa.git.gitlab.ci.ci_job_manager) Citation (class in prometa.citation) citation_cff_path (prometa.project.Project property) CodeMeta (class in prometa.codemeta.codemeta) codemeta_json_path (prometa.project.Project property)

CodeMetaError Config (class in prometa.config) config (prometa.config.Config property) config_paths (prometa.config.Config property) ConfigError configure_logging() (in module prometa.main) create_badge() (prometa.git.gitlab.badges.badge_manager.BadgeManager method) (prometa.git.gitlab.badges.BadgeManager method)

D

data (prometa.codemeta.codemeta.CodeMeta property) (prometa.git.gitlab.ci.GitLabCI property) delete_badge() (prometa.git.gitlab.badges.badge_manager.BadgeManager static method) (prometa.git.gitlab.badges.BadgeManager static method) description (prometa.package.Package property) (prometa.package.package.Package property) (prometa.package.python.package.PythonPackage property)

diff() (in module prometa.file) document_gitlab_badges() (in module prometa.scripts.document_gitlab_badges) document_gitlab_ci_jobs() (in module prometa.scripts.document_gitlab_ci_jobs) document_gitlab_hooks() (in module prometa.scripts.document_gitlab_hooks) document_labels() (in module prometa.scripts.document_labels)

E

enabled (prometa.git.gitlab.badges.badge_manager.BadgeManager property) (prometa.git.gitlab.badges.BadgeManager property) (prometa.git.gitlab.ci.ci_job_manager.CIJobManager property) (prometa.git.gitlab.ci.CIJobManager property) (prometa.git.gitlab.ci.python.pylint.PylintCIJobManager property) (prometa.git.gitlab.hooks.hook_manager.HookManager property) (prometa.git.gitlab.hooks.HookManager property)

F

format_docstring_for_cell() (in module prometa.utils)

G

get() (prometa.config.Config method) get_access_level() (in module prometa.git.gitlab.api) get_badge_by_name() (prometa.git.gitlab.badges.badge_manager.BadgeManager method) (prometa.git.gitlab.badges.BadgeManager method) get_badge_manager() (prometa.git.gitlab.badges.GitLabBadgesMixin method) get_badge_url() (in module prometa.git.gitlab.badges.common) get_ci_job_manager() (prometa.git.gitlab.ci.GitLabCI method) get_hal_id_from_url() (in module prometa.id.hal) get_hal_url_by_origin() (in module prometa.id.hal) get_hook_manager() (prometa.git.gitlab.hooks.GitLabHooksMixin method) get_json_or_none() (in module prometa.requests) get_license_classifier() (in module prometa.python.common) get_link() (prometa.insert.MarkdownInserter static method) get_main_blob_url() (prometa.git.GitRepo method) (prometa.git.repo.GitRepo method) get_markdown_badges() (prometa.git.gitlab.badges.GitLabBadgesMixin method) get_orcid_url() (in module prometa.id.orcid) get_output() (prometa.insert.MarkdownInserter method) (prometa.readme.ReadmeInserter method) get_primary_host() (prometa.git.GitHost class method) (prometa.git.host.GitHost class method) get_pypi_url() (in module prometa.python.common) get_section_url() (prometa.git.GitRepo method) (prometa.git.repo.GitRepo method)

get_swh_url_by_origin() (in module prometa.id.swh) get_swhid_by_origin() (in module prometa.id.swh) get_template() (prometa.citation.Citation static method) get_tool_configuration() (prometa.package.python.package.PythonPackage method) get_version() (prometa.package.python.package.PythonPackage method) GitHost (class in prometa.git) (class in prometa.git.host) gitlab (prometa.config.Config property) (prometa.git.gitlab.api.GitLabAPI property) gitlab_api (prometa.git.gitlab.host.GitLabHost property) gitlab_ci (prometa.git.gitlab.host.GitLabHost property) gitlab_config (prometa.git.gitlab.api.GitLabAPI property) gitlab_project (prometa.git.gitlab.api.GitLabAPI property) (prometa.git.gitlab.badges.badge_manager.BadgeManager property) (prometa.git.gitlab.badges.BadgeManager property) (prometa.git.gitlab.hooks.hook_manager.HookManager property) (prometa.git.gitlab.hooks.HookManager property) GitLabAPI (class in prometa.git.gitlab.api) GitLabBadgesMixin (class in prometa.git.gitlab.badges) GitLabCI (class in prometa.git.gitlab.ci) GitLabHooksMixin (class in prometa.git.gitlab.hooks) GitLabHost (class in prometa.git.gitlab.host) GitRepo (class in prometa.git) (class in prometa.git.repo)

H

HatchBadgeManager (class in prometa.git.gitlab.badges.python.hatch)

HookManager (class in prometa.git.gitlab.hooks) (class in prometa.git.gitlab.hooks.hook_manager)

I

include (prometa.git.gitlab.badges.badge_manager.BadgeManager property) (prometa.git.gitlab.badges.BadgeManager property) (prometa.git.gitlab.badges.latest_release.LatestReleaseBadgeManager property) (prometa.git.gitlab.badges.license.LicenseBadgeManager property) (prometa.git.gitlab.badges.pipeline_status.PipelineStatusBadgeManager property) (prometa.git.gitlab.badges.python.hatch.HatchBadgeManager property) (prometa.git.gitlab.badges.python.pypi.PyPIBadgeManager property) (prometa.git.gitlab.badges.python.pypi_downloads.PyPIDownloadsBadgeManager property) (prometa.git.gitlab.badges.python.python.PythonBadgeManager property) (prometa.git.gitlab.badges.python.python.ToggledPythonBadgeManager property) (prometa.git.gitlab.badges.test_coverage.TestCoverageBadgeManager property)

insert() (prometa.insert.Inserter method) (prometa.insert.MarkdownInserter method) Inserter (class in prometa.insert) is_used (prometa.git.GitHost property) (prometa.git.gitlab.host.GitLabHost property) (prometa.git.host.GitHost property) is_valid (prometa.package.Package property) (prometa.package.package.Package property) (prometa.package.python.package.PythonPackage property) IsortBadgeManager (class in prometa.git.gitlab.badges.python.isort)

J

join_docstrings() (in module prometa.utils)

L

labels (prometa.readme.ReadmeInserter property) LatestReleaseBadgeManager (class in prometa.git.gitlab.badges.latest_release) license_txt_path (prometa.project.Project property) LicenseBadgeManager (class in prometa.git.gitlab.badges.license)

links (prometa.package.Package property) (prometa.package.package.Package property) (prometa.package.python.package.PythonPackage property) load() (prometa.codemeta.codemeta.CodeMeta method) (prometa.git.gitlab.ci.GitLabCI method)

M

main() (in module prometa.main) main_branches (prometa.git.gitlab.host.GitLabHost property) manage() (prometa.git.gitlab.api.GitLabAPI method) (prometa.git.gitlab.badges.badge_manager.BadgeManager method) (prometa.git.gitlab.badges.BadgeManager method) (prometa.git.gitlab.ci.ci_job_manager.CIJobManager method) (prometa.git.gitlab.ci.CIJobManager method) (prometa.git.gitlab.ci.GitLabCI method) (prometa.git.gitlab.ci.pages.PagesCIJobManager method) (prometa.git.gitlab.ci.python.pylint.PylintCIJobManager method) (prometa.git.gitlab.ci.python.register_python_package.RegisterPythonPackageCIJobManager method) (prometa.git.gitlab.ci.release_job.ReleaseJobCIJobManager method) (prometa.git.gitlab.hooks.hook_manager.HookManager method) (prometa.git.gitlab.hooks.HookManager method) (prometa.git.gitlab.hooks.software_heritage.SoftwareHeritageHookManager method) manage_badges() (prometa.git.gitlab.badges.GitLabBadgesMixin method) manage_description() (prometa.git.gitlab.api.GitLabAPI method) manage_hooks() (prometa.git.gitlab.hooks.GitLabHooksMixin method) manage_merge_method() (prometa.git.gitlab.api.GitLabAPI method) manage_protected_branches() (prometa.git.gitlab.api.GitLabAPI method) manage_protected_tags() (prometa.git.gitlab.api.GitLabAPI method) MarkdownInserter (class in prometa.insert) modify_codemeta_data() (prometa.codemeta.codemeta.CodeMeta method) (prometa.package.python.codemeta.PyprojectCodeMeta method) module prometa prometa.citation prometa.codemeta prometa.codemeta.codemeta prometa.common prometa.config prometa.exception prometa.file prometa.git prometa.git.gitlab prometa.git.gitlab.api prometa.git.gitlab.badges prometa.git.gitlab.badges.badge_manager prometa.git.gitlab.badges.common prometa.git.gitlab.badges.latest_release prometa.git.gitlab.badges.license prometa.git.gitlab.badges.pipeline_status prometa.git.gitlab.badges.python prometa.git.gitlab.badges.python.black prometa.git.gitlab.badges.python.hatch prometa.git.gitlab.badges.python.isort prometa.git.gitlab.badges.python.pylint prometa.git.gitlab.badges.python.pypi prometa.git.gitlab.badges.python.pypi_downloads prometa.git.gitlab.badges.python.python prometa.git.gitlab.badges.test_coverage prometa.git.gitlab.ci prometa.git.gitlab.ci.ci_job_manager prometa.git.gitlab.ci.pages prometa.git.gitlab.ci.python prometa.git.gitlab.ci.python.pylint prometa.git.gitlab.ci.python.register_python_package prometa.git.gitlab.ci.release_job prometa.git.gitlab.hooks prometa.git.gitlab.hooks.hook_manager prometa.git.gitlab.hooks.software_heritage prometa.git.gitlab.host prometa.git.host prometa.git.repo prometa.id prometa.id.hal prometa.id.orcid prometa.id.swh prometa.insert prometa.main prometa.package prometa.package.package prometa.package.python prometa.package.python.codemeta prometa.package.python.package prometa.project prometa.python prometa.python.common prometa.python.venv prometa.readme prometa.requests prometa.scripts prometa.scripts.document_gitlab_badges prometa.scripts.document_gitlab_ci_jobs prometa.scripts.document_gitlab_hooks prometa.scripts.document_labels prometa.utils

N

name (prometa.codemeta.codemeta.CodeMeta property) NAME (prometa.git.gitlab.badges.badge_manager.BadgeManager attribute) (prometa.git.gitlab.badges.BadgeManager attribute) (prometa.git.gitlab.badges.latest_release.LatestReleaseBadgeManager attribute) (prometa.git.gitlab.badges.license.LicenseBadgeManager attribute) (prometa.git.gitlab.badges.pipeline_status.PipelineStatusBadgeManager attribute) (prometa.git.gitlab.badges.python.black.BlackBadgeManager attribute) (prometa.git.gitlab.badges.python.hatch.HatchBadgeManager attribute) (prometa.git.gitlab.badges.python.isort.IsortBadgeManager attribute) (prometa.git.gitlab.badges.python.pylint.PylintBadgeManager attribute) (prometa.git.gitlab.badges.python.pypi.PyPIBadgeManager attribute) (prometa.git.gitlab.badges.python.pypi_downloads.PyPIDownloadsBadgeManager attribute) (prometa.git.gitlab.badges.test_coverage.TestCoverageBadgeManager attribute) (prometa.git.gitlab.ci.ci_job_manager.CIJobManager attribute) (prometa.git.gitlab.ci.CIJobManager attribute) (prometa.git.gitlab.ci.pages.PagesCIJobManager attribute) (prometa.git.gitlab.ci.python.pylint.PylintCIJobManager attribute) (prometa.git.gitlab.ci.python.register_python_package.RegisterPythonPackageCIJobManager attribute) (prometa.git.gitlab.ci.release_job.ReleaseJobCIJobManager attribute) (prometa.git.gitlab.hooks.hook_manager.HookManager attribute) (prometa.git.gitlab.hooks.HookManager attribute) (prometa.git.gitlab.hooks.software_heritage.SoftwareHeritageHookManager attribute)

name (prometa.package.Package property) (prometa.package.package.Package property) (prometa.package.python.package.PythonPackage property) (prometa.project.Project property)

P

Package (class in prometa.package) (class in prometa.package.package) package (prometa.git.gitlab.badges.python.python.PythonBadgeManager property) PagesCIJobManager (class in prometa.git.gitlab.ci.pages) parsed_origin (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property) PipelineStatusBadgeManager (class in prometa.git.gitlab.badges.pipeline_status) possible_config_paths (prometa.config.Config property) prepend_docstrings() (in module prometa.utils) process_label_badges() (prometa.readme.ReadmeInserter method) process_label_citation() (prometa.readme.ReadmeInserter method) process_label_command() (prometa.readme.ReadmeInserter method) process_label_links() (prometa.readme.ReadmeInserter method) process_label_verbatim() (prometa.readme.ReadmeInserter method) Project (class in prometa.project) project (prometa.git.gitlab.api.GitLabAPI property) (prometa.git.gitlab.badges.badge_manager.BadgeManager property) (prometa.git.gitlab.badges.BadgeManager property) (prometa.git.gitlab.ci.GitLabCI property) (prometa.git.gitlab.hooks.hook_manager.HookManager property) (prometa.git.gitlab.hooks.HookManager property) prometa module prometa.citation module prometa.codemeta module prometa.codemeta.codemeta module prometa.common module prometa.config module prometa.exception module prometa.file module prometa.git module prometa.git.gitlab module prometa.git.gitlab.api module prometa.git.gitlab.badges module prometa.git.gitlab.badges.badge_manager module prometa.git.gitlab.badges.common module prometa.git.gitlab.badges.latest_release module prometa.git.gitlab.badges.license module prometa.git.gitlab.badges.pipeline_status module prometa.git.gitlab.badges.python module prometa.git.gitlab.badges.python.black module prometa.git.gitlab.badges.python.hatch module prometa.git.gitlab.badges.python.isort module prometa.git.gitlab.badges.python.pylint module prometa.git.gitlab.badges.python.pypi module prometa.git.gitlab.badges.python.pypi_downloads module prometa.git.gitlab.badges.python.python module prometa.git.gitlab.badges.test_coverage module prometa.git.gitlab.ci module prometa.git.gitlab.ci.ci_job_manager module prometa.git.gitlab.ci.pages module prometa.git.gitlab.ci.python module

prometa.git.gitlab.ci.python.pylint module prometa.git.gitlab.ci.python.register_python_package module prometa.git.gitlab.ci.release_job module prometa.git.gitlab.hooks module prometa.git.gitlab.hooks.hook_manager module prometa.git.gitlab.hooks.software_heritage module prometa.git.gitlab.host module prometa.git.host module prometa.git.repo module prometa.id module prometa.id.hal module prometa.id.orcid module prometa.id.swh module prometa.insert module prometa.main module prometa.package module prometa.package.package module prometa.package.python module prometa.package.python.codemeta module prometa.package.python.package module prometa.project module prometa.python module prometa.python.common module prometa.python.venv module prometa.readme module prometa.requests module prometa.scripts module prometa.scripts.document_gitlab_badges module prometa.scripts.document_gitlab_ci_jobs module prometa.scripts.document_gitlab_hooks module prometa.scripts.document_labels module prometa.utils module prometa_badge_list (prometa.git.gitlab.badges.python.python.ToggledPythonBadgeManager property) PrometaException public_git_url (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property) public_url (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property) PylintBadgeManager (class in prometa.git.gitlab.badges.python.pylint) PylintCIJobManager (class in prometa.git.gitlab.ci.python.pylint) pypi_url (prometa.package.python.package.PythonPackage property) PyPIBadgeManager (class in prometa.git.gitlab.badges.python.pypi) PyPIDownloadsBadgeManager (class in prometa.git.gitlab.badges.python.pypi_downloads) pyproject_toml_data (prometa.package.python.package.PythonPackage property) pyproject_toml_path (prometa.package.python.package.PythonPackage property) PyprojectCodeMeta (class in prometa.package.python.codemeta) PythonBadgeManager (class in prometa.git.gitlab.badges.python.python) PythonPackage (class in prometa.package.python.package)

R

readme_md_path (prometa.project.Project property) readme_url (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property) ReadmeInserter (class in prometa.readme) RegisterPythonPackageCIJobManager (class in prometa.git.gitlab.ci.python.register_python_package) ReleaseJobCIJobManager (class in prometa.git.gitlab.ci.release_job) remote_url (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property)

run_cmd() (prometa.git.GitRepo method) (prometa.git.repo.GitRepo method) (prometa.python.venv.VirtualEnvironment method) run_cmd_in_venv() (prometa.python.venv.VirtualEnvironment method) run_main() (in module prometa.main) run_pip_in_venv() (prometa.python.venv.VirtualEnvironment method) run_python_in_venv() (prometa.python.venv.VirtualEnvironment method)

S

SoftwareHeritageHookManager (class in prometa.git.gitlab.hooks.software_heritage) spdx_license (prometa.project.Project property)

swh_project_exists() (in module prometa.id.swh) sys_exe (prometa.python.venv.VirtualEnvironment property)

T

TestCoverageBadgeManager (class in prometa.git.gitlab.badges.test_coverage) ToggledPythonBadgeManager (class in prometa.git.gitlab.badges.python.python)

top_level (prometa.git.GitRepo property) (prometa.git.repo.GitRepo property)

U

update() (prometa.citation.Citation method) (prometa.codemeta.codemeta.CodeMeta method) (prometa.git.GitHost method) (prometa.git.gitlab.host.GitLabHost method) (prometa.git.host.GitHost method) (prometa.insert.Inserter method) (prometa.package.Package method) (prometa.package.package.Package method) (prometa.package.python.codemeta.PyprojectCodeMeta method) (prometa.package.python.package.PythonPackage method) (prometa.project.Project method) update_badge() (prometa.git.gitlab.badges.badge_manager.BadgeManager static method) (prometa.git.gitlab.badges.BadgeManager static method) update_content() (in module prometa.file) update_file() (prometa.codemeta.codemeta.CodeMeta method) update_pyproject_toml() (prometa.package.python.package.PythonPackage method) urls (prometa.git.GitHost property) (prometa.git.gitlab.badges.badge_manager.BadgeManager property) (prometa.git.gitlab.badges.BadgeManager property) (prometa.git.gitlab.badges.latest_release.LatestReleaseBadgeManager property) (prometa.git.gitlab.badges.license.LicenseBadgeManager property) (prometa.git.gitlab.badges.pipeline_status.PipelineStatusBadgeManager property) (prometa.git.gitlab.badges.python.black.BlackBadgeManager property) (prometa.git.gitlab.badges.python.hatch.HatchBadgeManager property) (prometa.git.gitlab.badges.python.isort.IsortBadgeManager property) (prometa.git.gitlab.badges.python.pylint.PylintBadgeManager property) (prometa.git.gitlab.badges.python.pypi.PyPIBadgeManager property) (prometa.git.gitlab.badges.python.pypi_downloads.PyPIDownloadsBadgeManager property) (prometa.git.gitlab.badges.test_coverage.TestCoverageBadgeManager property) (prometa.git.gitlab.host.GitLabHost property) (prometa.git.GitRepo property) (prometa.git.host.GitHost property) (prometa.git.repo.GitRepo property) (prometa.project.Project property)

uv_path (prometa.python.venv.VirtualEnvironment property)

V

VirtualEnvironment (class in prometa.python.venv)