Hammurabi
v0.7.4
Hammurabi
Installation
Configuration
Rules
Preconditions
Reporters
Notifications
hammurabi
Contributing
Vulnerabilities
Credits
CHANGELOG
Hammurabi
»
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
Y
A
AbortLawError
AbstractRule (class in hammurabi.rules.abstract)
additional_data (hammurabi.reporters.base.Report attribute)
AdditionalData (class in hammurabi.reporters.base)
C
can_proceed() (hammurabi.law.Law property)
(hammurabi.rules.base.Rule property)
checkout_branch() (hammurabi.mixins.GitMixin static method)
commit() (hammurabi.law.Law method)
CommonSettings (class in hammurabi.config)
CommonSettings.Config (class in hammurabi.config)
Config (class in hammurabi.config)
Copied (class in hammurabi.rules.operations)
create_pull_request() (hammurabi.mixins.GitHubMixin method)
D
description (hammurabi.reporters.base.LawItem attribute)
description() (hammurabi.rules.abstract.AbstractRule property)
DictKeyExists (class in hammurabi.rules.dictionaries)
DictKeyNotExists (class in hammurabi.rules.dictionaries)
DictKeyRenamed (class in hammurabi.rules.dictionaries)
DictValueExists (class in hammurabi.rules.dictionaries)
DictValueNotExists (class in hammurabi.rules.dictionaries)
DirectoryEmptied (class in hammurabi.rules.directories)
DirectoryExists (class in hammurabi.rules.directories)
DirectoryNotExists (class in hammurabi.rules.directories)
documentation() (hammurabi.law.Law property)
(hammurabi.rules.abstract.AbstractRule property)
dry_run (hammurabi.config.CommonSettings attribute)
E
enforce() (hammurabi.law.Law method)
(hammurabi.pillar.Pillar method)
env_prefix (hammurabi.config.CommonSettings.Config attribute)
execute() (hammurabi.preconditions.base.Precondition method)
(hammurabi.rules.base.Rule method)
F
failed (hammurabi.reporters.base.Report attribute)
failed_rules() (hammurabi.law.Law property)
FileEmptied (class in hammurabi.rules.files)
FileExists (class in hammurabi.rules.files)
FileNotExists (class in hammurabi.rules.files)
FilesExist (class in hammurabi.rules.files)
FilesNotExist (class in hammurabi.rules.files)
finished (hammurabi.reporters.base.AdditionalData attribute)
full_strip() (in module hammurabi.helpers)
G
generate_pull_request_body() (hammurabi.mixins.PullRequestHelperMixin method)
get_by_selector() (hammurabi.rules.mixins.SelectorMixin method)
get_execution_order() (hammurabi.law.Law method)
(hammurabi.rules.base.Rule method)
get_law() (hammurabi.pillar.Pillar method)
get_rule() (hammurabi.pillar.Pillar method)
get_rule_chain() (hammurabi.rules.base.Rule method)
git_add() (hammurabi.mixins.GitMixin method)
git_base_name (hammurabi.config.CommonSettings attribute)
git_branch_name (hammurabi.config.CommonSettings attribute)
git_commit() (hammurabi.mixins.GitMixin method)
git_remove() (hammurabi.mixins.GitMixin method)
github_token (hammurabi.config.TOMLSettings attribute)
GitHubMixin (class in hammurabi.mixins)
GitMixin (class in hammurabi.mixins)
H
hammurabi (module)
hammurabi.config (module)
hammurabi.exceptions (module)
hammurabi.helpers (module)
hammurabi.law (module)
hammurabi.main (module)
hammurabi.mixins (module)
hammurabi.notifications (module)
hammurabi.notifications.base (module)
hammurabi.notifications.slack (module)
hammurabi.pillar (module)
hammurabi.preconditions (module)
hammurabi.preconditions.attributes (module)
hammurabi.preconditions.base (module)
hammurabi.preconditions.directories (module)
hammurabi.preconditions.files (module)
hammurabi.preconditions.text (module)
hammurabi.reporters (module)
hammurabi.reporters.base (module)
hammurabi.reporters.json (module)
hammurabi.rules (module)
hammurabi.rules.abstract (module)
hammurabi.rules.attributes (module)
hammurabi.rules.base (module)
hammurabi.rules.common (module)
hammurabi.rules.dictionaries (module)
hammurabi.rules.directories (module)
hammurabi.rules.files (module)
hammurabi.rules.ini (module)
hammurabi.rules.json (module)
hammurabi.rules.mixins (module)
hammurabi.rules.operations (module)
hammurabi.rules.templates (module)
hammurabi.rules.text (module)
hammurabi.rules.yaml (module)
HasMode (class in hammurabi.preconditions.attributes)
HasNoMode (class in hammurabi.preconditions.attributes)
I
IsDirectoryExists (class in hammurabi.preconditions.directories)
IsDirectoryNotExists (class in hammurabi.preconditions.directories)
IsFileExists (class in hammurabi.preconditions.files)
IsFileNotExists (class in hammurabi.preconditions.files)
IsLineExists (class in hammurabi.preconditions.text)
IsLineNotExists (class in hammurabi.preconditions.text)
IsNotOwnedBy (class in hammurabi.preconditions.attributes)
IsOwnedBy (class in hammurabi.preconditions.attributes)
J
JSONKeyExists (class in hammurabi.rules.json)
JSONKeyNotExists (class in hammurabi.rules.json)
JSONKeyRenamed (class in hammurabi.rules.json)
JSONReporter (class in hammurabi.reporters.json)
JSONValueExists (class in hammurabi.rules.json)
JSONValueNotExists (class in hammurabi.rules.json)
L
Law (class in hammurabi.law)
law (hammurabi.reporters.base.RuleItem attribute)
LawItem (class in hammurabi.reporters.base)
laws() (hammurabi.pillar.Pillar property)
LineExists (class in hammurabi.rules.text)
LineNotExists (class in hammurabi.rules.text)
LineReplaced (class in hammurabi.rules.text)
load() (hammurabi.config.Config method)
log_format (hammurabi.config.TOMLSettings attribute)
log_level (hammurabi.config.TOMLSettings attribute)
log_path (hammurabi.config.TOMLSettings attribute)
M
made_changes (hammurabi.preconditions.attributes.HasMode attribute)
(hammurabi.preconditions.attributes.HasNoMode attribute)
(hammurabi.preconditions.attributes.IsNotOwnedBy attribute)
(hammurabi.preconditions.attributes.IsOwnedBy attribute)
(hammurabi.preconditions.base.Precondition attribute)
(hammurabi.preconditions.directories.IsDirectoryExists attribute)
(hammurabi.preconditions.directories.IsDirectoryNotExists attribute)
(hammurabi.preconditions.files.IsFileExists attribute)
(hammurabi.preconditions.files.IsFileNotExists attribute)
(hammurabi.preconditions.text.IsLineExists attribute)
(hammurabi.preconditions.text.IsLineNotExists attribute)
(hammurabi.rules.abstract.AbstractRule attribute)
(hammurabi.rules.attributes.ModeChanged attribute)
(hammurabi.rules.attributes.OwnerChanged attribute)
(hammurabi.rules.attributes.SingleAttributeRule attribute)
(hammurabi.rules.base.Rule attribute)
(hammurabi.rules.common.MultiplePathRule attribute)
(hammurabi.rules.common.SinglePathRule attribute)
(hammurabi.rules.dictionaries.DictKeyExists attribute)
(hammurabi.rules.dictionaries.DictKeyNotExists attribute)
(hammurabi.rules.dictionaries.DictKeyRenamed attribute)
(hammurabi.rules.dictionaries.DictValueExists attribute)
(hammurabi.rules.dictionaries.DictValueNotExists attribute)
(hammurabi.rules.dictionaries.SinglePathDictParsedRule attribute)
(hammurabi.rules.directories.DirectoryEmptied attribute)
(hammurabi.rules.directories.DirectoryExists attribute)
(hammurabi.rules.directories.DirectoryNotExists attribute)
(hammurabi.rules.files.FileEmptied attribute)
(hammurabi.rules.files.FileExists attribute)
(hammurabi.rules.files.FileNotExists attribute)
(hammurabi.rules.files.FilesExist attribute)
(hammurabi.rules.files.FilesNotExist attribute)
(hammurabi.rules.ini.OptionRenamed attribute)
(hammurabi.rules.ini.OptionsExist attribute)
(hammurabi.rules.ini.OptionsNotExist attribute)
(hammurabi.rules.ini.SectionExists attribute)
(hammurabi.rules.ini.SectionNotExists attribute)
(hammurabi.rules.ini.SectionRenamed attribute)
(hammurabi.rules.ini.SingleConfigFileRule attribute)
(hammurabi.rules.json.JSONKeyExists attribute)
(hammurabi.rules.json.JSONKeyNotExists attribute)
(hammurabi.rules.json.JSONKeyRenamed attribute)
(hammurabi.rules.json.JSONValueExists attribute)
(hammurabi.rules.json.JSONValueNotExists attribute)
(hammurabi.rules.json.SingleJSONFileRule attribute)
(hammurabi.rules.operations.Copied attribute)
(hammurabi.rules.operations.Moved attribute)
(hammurabi.rules.operations.Renamed attribute)
(hammurabi.rules.templates.TemplateRendered attribute)
(hammurabi.rules.text.LineExists attribute)
(hammurabi.rules.text.LineNotExists attribute)
(hammurabi.rules.text.LineReplaced attribute)
(hammurabi.rules.yaml.SingleDocumentYAMLFileRule attribute)
(hammurabi.rules.yaml.YAMLKeyExists attribute)
(hammurabi.rules.yaml.YAMLKeyNotExists attribute)
(hammurabi.rules.yaml.YAMLKeyRenamed attribute)
(hammurabi.rules.yaml.YAMLValueExists attribute)
(hammurabi.rules.yaml.YAMLValueNotExists attribute)
ModeChanged (class in hammurabi.rules.attributes)
Moved (class in hammurabi.rules.operations)
MultiplePathRule (class in hammurabi.rules.common)
N
name (hammurabi.preconditions.attributes.HasMode attribute)
(hammurabi.preconditions.attributes.HasNoMode attribute)
(hammurabi.preconditions.attributes.IsNotOwnedBy attribute)
(hammurabi.preconditions.attributes.IsOwnedBy attribute)
(hammurabi.preconditions.base.Precondition attribute)
(hammurabi.preconditions.directories.IsDirectoryExists attribute)
(hammurabi.preconditions.directories.IsDirectoryNotExists attribute)
(hammurabi.preconditions.files.IsFileExists attribute)
(hammurabi.preconditions.files.IsFileNotExists attribute)
(hammurabi.preconditions.text.IsLineExists attribute)
(hammurabi.preconditions.text.IsLineNotExists attribute)
(hammurabi.reporters.base.LawItem attribute)
(hammurabi.reporters.base.RuleItem attribute)
(hammurabi.rules.abstract.AbstractRule attribute)
(hammurabi.rules.attributes.ModeChanged attribute)
(hammurabi.rules.attributes.OwnerChanged attribute)
(hammurabi.rules.attributes.SingleAttributeRule attribute)
(hammurabi.rules.base.Rule attribute)
(hammurabi.rules.common.MultiplePathRule attribute)
(hammurabi.rules.common.SinglePathRule attribute)
(hammurabi.rules.dictionaries.DictKeyExists attribute)
(hammurabi.rules.dictionaries.DictKeyNotExists attribute)
(hammurabi.rules.dictionaries.DictKeyRenamed attribute)
(hammurabi.rules.dictionaries.DictValueExists attribute)
(hammurabi.rules.dictionaries.DictValueNotExists attribute)
(hammurabi.rules.dictionaries.SinglePathDictParsedRule attribute)
(hammurabi.rules.directories.DirectoryEmptied attribute)
(hammurabi.rules.directories.DirectoryExists attribute)
(hammurabi.rules.directories.DirectoryNotExists attribute)
(hammurabi.rules.files.FileEmptied attribute)
(hammurabi.rules.files.FileExists attribute)
(hammurabi.rules.files.FileNotExists attribute)
(hammurabi.rules.files.FilesExist attribute)
(hammurabi.rules.files.FilesNotExist attribute)
(hammurabi.rules.ini.OptionRenamed attribute)
(hammurabi.rules.ini.OptionsExist attribute)
(hammurabi.rules.ini.OptionsNotExist attribute)
(hammurabi.rules.ini.SectionExists attribute)
(hammurabi.rules.ini.SectionNotExists attribute)
(hammurabi.rules.ini.SectionRenamed attribute)
(hammurabi.rules.ini.SingleConfigFileRule attribute)
(hammurabi.rules.json.JSONKeyExists attribute)
(hammurabi.rules.json.JSONKeyNotExists attribute)
(hammurabi.rules.json.JSONKeyRenamed attribute)
(hammurabi.rules.json.JSONValueExists attribute)
(hammurabi.rules.json.JSONValueNotExists attribute)
(hammurabi.rules.json.SingleJSONFileRule attribute)
(hammurabi.rules.operations.Copied attribute)
(hammurabi.rules.operations.Moved attribute)
(hammurabi.rules.operations.Renamed attribute)
(hammurabi.rules.templates.TemplateRendered attribute)
(hammurabi.rules.text.LineExists attribute)
(hammurabi.rules.text.LineNotExists attribute)
(hammurabi.rules.text.LineReplaced attribute)
(hammurabi.rules.yaml.SingleDocumentYAMLFileRule attribute)
(hammurabi.rules.yaml.YAMLKeyExists attribute)
(hammurabi.rules.yaml.YAMLKeyNotExists attribute)
(hammurabi.rules.yaml.YAMLKeyRenamed attribute)
(hammurabi.rules.yaml.YAMLValueExists attribute)
(hammurabi.rules.yaml.YAMLValueNotExists attribute)
Notification (class in hammurabi.notifications.base)
NotificationSendError
notify() (hammurabi.notifications.base.Notification method)
(hammurabi.notifications.slack.SlackNotification method)
O
OptionRenamed (class in hammurabi.rules.ini)
OptionsExist (class in hammurabi.rules.ini)
OptionsNotExist (class in hammurabi.rules.ini)
OwnerChanged (class in hammurabi.rules.attributes)
P
param (hammurabi.preconditions.attributes.HasMode attribute)
(hammurabi.preconditions.attributes.HasNoMode attribute)
(hammurabi.preconditions.attributes.IsNotOwnedBy attribute)
(hammurabi.preconditions.attributes.IsOwnedBy attribute)
(hammurabi.preconditions.base.Precondition attribute)
(hammurabi.preconditions.directories.IsDirectoryExists attribute)
(hammurabi.preconditions.directories.IsDirectoryNotExists attribute)
(hammurabi.preconditions.files.IsFileExists attribute)
(hammurabi.preconditions.files.IsFileNotExists attribute)
(hammurabi.preconditions.text.IsLineExists attribute)
(hammurabi.preconditions.text.IsLineNotExists attribute)
(hammurabi.rules.abstract.AbstractRule attribute)
(hammurabi.rules.attributes.ModeChanged attribute)
(hammurabi.rules.attributes.OwnerChanged attribute)
(hammurabi.rules.attributes.SingleAttributeRule attribute)
(hammurabi.rules.base.Rule attribute)
(hammurabi.rules.common.MultiplePathRule attribute)
(hammurabi.rules.common.SinglePathRule attribute)
(hammurabi.rules.dictionaries.DictKeyExists attribute)
(hammurabi.rules.dictionaries.DictKeyNotExists attribute)
(hammurabi.rules.dictionaries.DictKeyRenamed attribute)
(hammurabi.rules.dictionaries.DictValueExists attribute)
(hammurabi.rules.dictionaries.DictValueNotExists attribute)
(hammurabi.rules.dictionaries.SinglePathDictParsedRule attribute)
(hammurabi.rules.directories.DirectoryEmptied attribute)
(hammurabi.rules.directories.DirectoryExists attribute)
(hammurabi.rules.directories.DirectoryNotExists attribute)
(hammurabi.rules.files.FileEmptied attribute)
(hammurabi.rules.files.FileExists attribute)
(hammurabi.rules.files.FileNotExists attribute)
(hammurabi.rules.files.FilesExist attribute)
(hammurabi.rules.files.FilesNotExist attribute)
(hammurabi.rules.ini.OptionRenamed attribute)
(hammurabi.rules.ini.OptionsExist attribute)
(hammurabi.rules.ini.OptionsNotExist attribute)
(hammurabi.rules.ini.SectionExists attribute)
(hammurabi.rules.ini.SectionNotExists attribute)
(hammurabi.rules.ini.SectionRenamed attribute)
(hammurabi.rules.ini.SingleConfigFileRule attribute)
(hammurabi.rules.json.JSONKeyExists attribute)
(hammurabi.rules.json.JSONKeyNotExists attribute)
(hammurabi.rules.json.JSONKeyRenamed attribute)
(hammurabi.rules.json.JSONValueExists attribute)
(hammurabi.rules.json.JSONValueNotExists attribute)
(hammurabi.rules.json.SingleJSONFileRule attribute)
(hammurabi.rules.operations.Copied attribute)
(hammurabi.rules.operations.Moved attribute)
(hammurabi.rules.operations.Renamed attribute)
(hammurabi.rules.templates.TemplateRendered attribute)
(hammurabi.rules.text.LineExists attribute)
(hammurabi.rules.text.LineNotExists attribute)
(hammurabi.rules.text.LineReplaced attribute)
(hammurabi.rules.yaml.SingleDocumentYAMLFileRule attribute)
(hammurabi.rules.yaml.YAMLKeyExists attribute)
(hammurabi.rules.yaml.YAMLKeyNotExists attribute)
(hammurabi.rules.yaml.YAMLKeyRenamed attribute)
(hammurabi.rules.yaml.YAMLValueExists attribute)
(hammurabi.rules.yaml.YAMLValueNotExists attribute)
passed (hammurabi.reporters.base.Report attribute)
passed_rules() (hammurabi.law.Law property)
Pillar (class in hammurabi.pillar)
pillar (hammurabi.config.Settings attribute)
pillar_config (hammurabi.config.TOMLSettings attribute)
pillar_name (hammurabi.config.TOMLSettings attribute)
post_task_hook() (hammurabi.rules.abstract.AbstractRule method)
(hammurabi.rules.attributes.SingleAttributeRule method)
(hammurabi.rules.common.MultiplePathRule method)
(hammurabi.rules.common.SinglePathRule method)
(hammurabi.rules.directories.DirectoryNotExists method)
(hammurabi.rules.files.FileNotExists method)
(hammurabi.rules.files.FilesNotExist method)
(hammurabi.rules.operations.Copied method)
(hammurabi.rules.operations.Moved method)
(hammurabi.rules.templates.TemplateRendered method)
pre_task_hook() (hammurabi.rules.abstract.AbstractRule method)
(hammurabi.rules.dictionaries.SinglePathDictParsedRule method)
(hammurabi.rules.ini.SingleConfigFileRule method)
Precondition (class in hammurabi.preconditions.base)
PreconditionFailedError
pull_request_url (hammurabi.reporters.base.AdditionalData attribute)
PullRequestHelperMixin (class in hammurabi.mixins)
push_changes() (hammurabi.mixins.GitMixin static method)
R
register() (hammurabi.pillar.Pillar method)
Renamed (class in hammurabi.rules.operations)
Report (class in hammurabi.reporters.base)
report() (hammurabi.reporters.base.Reporter method)
(hammurabi.reporters.json.JSONReporter method)
report_name (hammurabi.config.CommonSettings attribute)
Reporter (class in hammurabi.reporters.base)
repository (hammurabi.config.CommonSettings attribute)
Rule (class in hammurabi.rules.base)
rule_can_abort (hammurabi.config.CommonSettings attribute)
RuleItem (class in hammurabi.reporters.base)
rules() (hammurabi.pillar.Pillar property)
S
SectionExists (class in hammurabi.rules.ini)
SectionNotExists (class in hammurabi.rules.ini)
SectionRenamed (class in hammurabi.rules.ini)
SelectorMixin (class in hammurabi.rules.mixins)
send() (hammurabi.notifications.base.Notification method)
set_by_selector() (hammurabi.rules.mixins.SelectorMixin method)
Settings (class in hammurabi.config)
SingleAttributeRule (class in hammurabi.rules.attributes)
SingleConfigFileRule (class in hammurabi.rules.ini)
SingleDocumentYAMLFileRule (class in hammurabi.rules.yaml)
SingleJSONFileRule (class in hammurabi.rules.json)
SinglePathDictParsedRule (class in hammurabi.rules.dictionaries)
SinglePathRule (class in hammurabi.rules.common)
skipped (hammurabi.reporters.base.Report attribute)
skipped_rules() (hammurabi.law.Law property)
SlackNotification (class in hammurabi.notifications.slack)
started (hammurabi.reporters.base.AdditionalData attribute)
T
task() (hammurabi.preconditions.attributes.HasMode method)
(hammurabi.preconditions.attributes.HasNoMode method)
(hammurabi.preconditions.attributes.IsNotOwnedBy method)
(hammurabi.preconditions.attributes.IsOwnedBy method)
(hammurabi.preconditions.base.Precondition method)
(hammurabi.preconditions.directories.IsDirectoryExists method)
(hammurabi.preconditions.directories.IsDirectoryNotExists method)
(hammurabi.preconditions.files.IsFileExists method)
(hammurabi.preconditions.files.IsFileNotExists method)
(hammurabi.preconditions.text.IsLineExists method)
(hammurabi.preconditions.text.IsLineNotExists method)
(hammurabi.rules.abstract.AbstractRule method)
(hammurabi.rules.attributes.ModeChanged method)
(hammurabi.rules.attributes.OwnerChanged method)
(hammurabi.rules.attributes.SingleAttributeRule method)
(hammurabi.rules.base.Rule method)
(hammurabi.rules.common.MultiplePathRule method)
(hammurabi.rules.common.SinglePathRule method)
(hammurabi.rules.dictionaries.DictKeyExists method)
(hammurabi.rules.dictionaries.DictKeyNotExists method)
(hammurabi.rules.dictionaries.DictKeyRenamed method)
(hammurabi.rules.dictionaries.DictValueExists method)
(hammurabi.rules.dictionaries.DictValueNotExists method)
(hammurabi.rules.dictionaries.SinglePathDictParsedRule method)
(hammurabi.rules.directories.DirectoryEmptied method)
(hammurabi.rules.directories.DirectoryExists method)
(hammurabi.rules.directories.DirectoryNotExists method)
(hammurabi.rules.files.FileEmptied method)
(hammurabi.rules.files.FileExists method)
(hammurabi.rules.files.FileNotExists method)
(hammurabi.rules.files.FilesExist method)
(hammurabi.rules.files.FilesNotExist method)
(hammurabi.rules.ini.OptionRenamed method)
(hammurabi.rules.ini.OptionsExist method)
(hammurabi.rules.ini.OptionsNotExist method)
(hammurabi.rules.ini.SectionExists method)
(hammurabi.rules.ini.SectionNotExists method)
(hammurabi.rules.ini.SectionRenamed method)
(hammurabi.rules.ini.SingleConfigFileRule method)
(hammurabi.rules.json.SingleJSONFileRule method)
(hammurabi.rules.operations.Copied method)
(hammurabi.rules.operations.Moved method)
(hammurabi.rules.templates.TemplateRendered method)
(hammurabi.rules.text.LineExists method)
(hammurabi.rules.text.LineNotExists method)
(hammurabi.rules.text.LineReplaced method)
(hammurabi.rules.yaml.SingleDocumentYAMLFileRule method)
TemplateRendered (class in hammurabi.rules.templates)
TOMLSettings (class in hammurabi.config)
V
validate() (hammurabi.rules.abstract.AbstractRule static method)
Y
YAMLKeyExists (class in hammurabi.rules.yaml)
YAMLKeyNotExists (class in hammurabi.rules.yaml)
YAMLKeyRenamed (class in hammurabi.rules.yaml)
YAMLValueExists (class in hammurabi.rules.yaml)
YAMLValueNotExists (class in hammurabi.rules.yaml)
Read the Docs
v: v0.7.4
Versions
latest
stable
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.1
v0.3.0
v0.2.0
v0.1.2
v0.1.1
v0.1.0
Downloads
On Read the Docs
Project Home
Builds