howfairis
stable
CLI Reference
API Reference
howfairis
»
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
Symbols
--branch
howfairis command line option
--ignore-repo-config
howfairis command line option
--path
howfairis command line option
--quiet
howfairis command line option
--repo-config-filename
howfairis command line option
--show-default-config
howfairis command line option
--show-trace
howfairis command line option
--user-config-filename
howfairis command line option
--version
howfairis command line option
-b
howfairis command line option
-d
howfairis command line option
-i
howfairis command line option
-p
howfairis command line option
-q
howfairis command line option
-r
howfairis command line option
-t
howfairis command line option
-u
howfairis command line option
-v
howfairis command line option
A
api (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
as_unicode() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
B
badge_image_url() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
branch (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
C
calc_badge() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
check_checklist() (howfairis.mixins.checklist_mixin.ChecklistMixin method)
check_citation() (howfairis.mixins.citation_mixin.CitationMixin method)
check_five_recommendations() (howfairis.Checker method)
(howfairis.checker.Checker method)
check_license() (howfairis.mixins.license_mixin.LicenseMixin method)
check_registry() (howfairis.mixins.registry_mixin.RegistryMixin method)
check_repository() (howfairis.mixins.repository_mixin.RepositoryMixin method)
Checker (class in howfairis)
(class in howfairis.checker)
checklist (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
ChecklistMixin (class in howfairis.mixins.checklist_mixin)
citation (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
CitationMixin (class in howfairis.mixins.citation_mixin)
color() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
Compliance (class in howfairis)
(class in howfairis.compliance)
COMPLIANT_SYMBOL (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
(howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
count() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
D
default_branch (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
F
file_format (howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
filename (howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
find_license_gitlab() (in module howfairis.workarounds.find_license_gitlab)
G
get_apikeys_from_env_vars() (in module howfairis.get_apikeys_from_env_vars)
get_calls() (in module howfairis.requesting.get_from_github_no_auth)
(in module howfairis.requesting.get_from_gitlab_no_auth)
get_compliance() (howfairis.Readme method)
(howfairis.readme.Readme method)
get_from_github() (in module howfairis.requesting.get_from_github)
get_from_github_no_auth() (in module howfairis.requesting.get_from_github_no_auth)
get_from_github_no_auth_api() (in module howfairis.requesting.get_from_github_no_auth_api)
get_from_github_no_auth_frontend() (in module howfairis.requesting.get_from_github_no_auth_frontend)
get_from_github_no_auth_raw() (in module howfairis.requesting.get_from_github_no_auth_raw)
get_from_github_with_auth() (in module howfairis.requesting.get_from_github_with_auth)
get_from_github_with_auth_api() (in module howfairis.requesting.get_from_github_with_auth_api)
get_from_github_with_auth_frontend() (in module howfairis.requesting.get_from_github_with_auth_frontend)
get_from_github_with_auth_raw() (in module howfairis.requesting.get_from_github_with_auth_raw)
get_from_gitlab() (in module howfairis.requesting.get_from_gitlab)
get_from_gitlab_no_auth() (in module howfairis.requesting.get_from_gitlab_no_auth)
get_from_gitlab_no_auth_api() (in module howfairis.requesting.get_from_gitlab_no_auth_api)
get_from_gitlab_no_auth_frontend() (in module howfairis.requesting.get_from_gitlab_no_auth_frontend)
get_from_gitlab_no_auth_raw() (in module howfairis.requesting.get_from_gitlab_no_auth_raw)
get_from_gitlab_with_auth() (in module howfairis.requesting.get_from_gitlab_with_auth)
get_from_gitlab_with_auth_api() (in module howfairis.requesting.get_from_gitlab_with_auth_api)
get_from_gitlab_with_auth_frontend() (in module howfairis.requesting.get_from_gitlab_with_auth_frontend)
get_from_gitlab_with_auth_raw() (in module howfairis.requesting.get_from_gitlab_with_auth_raw)
get_from_platform() (in module howfairis.requesting.get_from_platform)
GetDefaultBranchException
GITHUB (howfairis.code_repository_platforms.Platform attribute)
(howfairis.Platform attribute)
github_caching_check() (in module howfairis.workarounds.github_caching)
GITLAB (howfairis.code_repository_platforms.Platform attribute)
(howfairis.Platform attribute)
H
has_ascl_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_bintray_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_citation_file() (howfairis.mixins.citation_mixin.CitationMixin method)
has_citationcff_file() (howfairis.mixins.citation_mixin.CitationMixin method)
has_codemeta_file() (howfairis.mixins.citation_mixin.CitationMixin method)
has_conda_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_core_infrastructures_badge() (howfairis.mixins.checklist_mixin.ChecklistMixin method)
has_cran_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_crates_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_license() (howfairis.mixins.license_mixin.LicenseMixin method)
has_maven_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_npm_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_open_repository() (howfairis.mixins.repository_mixin.RepositoryMixin method)
has_pypi_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_rsd_badge() (howfairis.mixins.registry_mixin.RegistryMixin method)
has_zenodo_badge() (howfairis.mixins.citation_mixin.CitationMixin method)
has_zenodo_metadata_file() (howfairis.mixins.citation_mixin.CitationMixin method)
howfairis
module
howfairis command line option
--branch
--ignore-repo-config
--path
--quiet
--repo-config-filename
--show-default-config
--show-trace
--user-config-filename
--version
-b
-d
-i
-p
-q
-r
-t
-u
-v
URL
howfairis.checker
module
howfairis.cli
module
howfairis.cli.cli
module
howfairis.cli.print_call_to_action
module
howfairis.cli.print_default_config
module
howfairis.cli.print_feedback_about_config_args
module
howfairis.cli.print_feedback_about_repo_args
module
howfairis.cli.print_version
module
howfairis.code_repository_platforms
module
howfairis.compliance
module
howfairis.exceptions
module
howfairis.exceptions.get_default_branch_exception
module
howfairis.exceptions.howfairis_exception
module
howfairis.exceptions.howfairis_unknown_platform_exception
module
howfairis.get_apikeys_from_env_vars
module
howfairis.mixins
module
howfairis.mixins.checklist_mixin
module
howfairis.mixins.citation_mixin
module
howfairis.mixins.license_mixin
module
howfairis.mixins.registry_mixin
module
howfairis.mixins.repository_mixin
module
howfairis.readme
module
howfairis.readme_format
module
howfairis.repo
module
howfairis.requesting
module
howfairis.requesting.get_from_github
module
howfairis.requesting.get_from_github_no_auth
module
howfairis.requesting.get_from_github_no_auth_api
module
howfairis.requesting.get_from_github_no_auth_frontend
module
howfairis.requesting.get_from_github_no_auth_raw
module
howfairis.requesting.get_from_github_with_auth
module
howfairis.requesting.get_from_github_with_auth_api
module
howfairis.requesting.get_from_github_with_auth_frontend
module
howfairis.requesting.get_from_github_with_auth_raw
module
howfairis.requesting.get_from_gitlab
module
howfairis.requesting.get_from_gitlab_no_auth
module
howfairis.requesting.get_from_gitlab_no_auth_api
module
howfairis.requesting.get_from_gitlab_no_auth_frontend
module
howfairis.requesting.get_from_gitlab_no_auth_raw
module
howfairis.requesting.get_from_gitlab_with_auth
module
howfairis.requesting.get_from_gitlab_with_auth_api
module
howfairis.requesting.get_from_gitlab_with_auth_frontend
module
howfairis.requesting.get_from_gitlab_with_auth_raw
module
howfairis.requesting.get_from_platform
module
howfairis.schema
module
howfairis.workarounds
module
howfairis.workarounds.find_license_gitlab
module
howfairis.workarounds.github_caching
module
HowfairisException
HowfairisUnknownPlatformException
I
ignore_commented_badges (howfairis.Checker property)
(howfairis.checker.Checker property)
is_on_github_marketplace() (howfairis.mixins.registry_mixin.RegistryMixin method)
is_quiet (howfairis.Checker attribute)
(howfairis.checker.Checker attribute)
L
license (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
LicenseMixin (class in howfairis.mixins.license_mixin)
M
MARKDOWN (howfairis.readme_format.ReadmeFormat attribute)
module
howfairis
howfairis.checker
howfairis.cli
howfairis.cli.cli
howfairis.cli.print_call_to_action
howfairis.cli.print_default_config
howfairis.cli.print_feedback_about_config_args
howfairis.cli.print_feedback_about_repo_args
howfairis.cli.print_version
howfairis.code_repository_platforms
howfairis.compliance
howfairis.exceptions
howfairis.exceptions.get_default_branch_exception
howfairis.exceptions.howfairis_exception
howfairis.exceptions.howfairis_unknown_platform_exception
howfairis.get_apikeys_from_env_vars
howfairis.mixins
howfairis.mixins.checklist_mixin
howfairis.mixins.citation_mixin
howfairis.mixins.license_mixin
howfairis.mixins.registry_mixin
howfairis.mixins.repository_mixin
howfairis.readme
howfairis.readme_format
howfairis.repo
howfairis.requesting
howfairis.requesting.get_from_github
howfairis.requesting.get_from_github_no_auth
howfairis.requesting.get_from_github_no_auth_api
howfairis.requesting.get_from_github_no_auth_frontend
howfairis.requesting.get_from_github_no_auth_raw
howfairis.requesting.get_from_github_with_auth
howfairis.requesting.get_from_github_with_auth_api
howfairis.requesting.get_from_github_with_auth_frontend
howfairis.requesting.get_from_github_with_auth_raw
howfairis.requesting.get_from_gitlab
howfairis.requesting.get_from_gitlab_no_auth
howfairis.requesting.get_from_gitlab_no_auth_api
howfairis.requesting.get_from_gitlab_no_auth_frontend
howfairis.requesting.get_from_gitlab_no_auth_raw
howfairis.requesting.get_from_gitlab_with_auth
howfairis.requesting.get_from_gitlab_with_auth_api
howfairis.requesting.get_from_gitlab_with_auth_frontend
howfairis.requesting.get_from_gitlab_with_auth_raw
howfairis.requesting.get_from_platform
howfairis.schema
howfairis.workarounds
howfairis.workarounds.find_license_gitlab
howfairis.workarounds.github_caching
N
NONCOMPLIANT_SYMBOL (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
(howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
O
owner (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
P
path (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
Platform (class in howfairis)
(class in howfairis.code_repository_platforms)
platform (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
print_call_to_action() (in module howfairis.cli.print_call_to_action)
print_default_config() (in module howfairis.cli.print_default_config)
print_feedback_about_config_args() (in module howfairis.cli.print_feedback_about_config_args)
print_feedback_about_repo_args() (in module howfairis.cli.print_feedback_about_repo_args)
print_version() (in module howfairis.cli.print_version)
R
raw_url_format_string (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
Readme (class in howfairis)
(class in howfairis.readme)
readme (howfairis.Checker attribute)
(howfairis.checker.Checker attribute)
ReadmeFormat (class in howfairis.readme_format)
registry (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
RegistryMixin (class in howfairis.mixins.registry_mixin)
Repo (class in howfairis)
(class in howfairis.repo)
repo (howfairis.Checker attribute)
(howfairis.checker.Checker attribute)
(howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
repository (howfairis.Compliance attribute)
(howfairis.compliance.Compliance attribute)
RepositoryMixin (class in howfairis.mixins.repository_mixin)
RESTRUCTUREDTEXT (howfairis.readme_format.ReadmeFormat attribute)
S
SEPARATOR (howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
skip_checklist_checks_reason (howfairis.Checker property)
(howfairis.checker.Checker property)
skip_citation_checks_reason (howfairis.Checker property)
(howfairis.checker.Checker property)
skip_license_checks_reason (howfairis.Checker property)
(howfairis.checker.Checker property)
skip_registry_checks_reason (howfairis.Checker property)
(howfairis.checker.Checker property)
skip_repository_checks_reason (howfairis.Checker property)
(howfairis.checker.Checker property)
T
text (howfairis.Readme attribute)
(howfairis.readme.Readme attribute)
U
URL
howfairis command line option
url (howfairis.Repo attribute)
(howfairis.repo.Repo attribute)
urlencode() (howfairis.Compliance method)
(howfairis.compliance.Compliance method)
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds