Merge branch 'releases/1.1.x' into main

.editorconfig

@@ -15,11 +15,13 @@ charset = utf-8
 max_line_length = 88
 
 # YAML files are indented by 2 spaces
-[*.yml]
-indent_size = 2
-
-[*.yaml]
+[*.{yaml,yml}]
 indent_size = 2
 
+# Markdown files are indented by 2 spaces
 [*.md]
 indent_size = 2
+
+# Restructured text are indented by 4 spaces (not 3)
+[*.rst]
+indent_size = 4

README.md

@@ -35,7 +35,7 @@ Layered environments could include a _common_ or _base_ environment, with
 additional checks for settings of _test_, _development_ and _production_
 environments.
 
-In the following checks file, the existence of environment file and secrets
+In the following checks file, the existence of an environment file and a secrets
 file can be checked based on the ``$ENV`` environment variable. (See the
 [docker environment variable parameter expansion rules](https://docs.docker.com/compose/environment-variables/env-file/#parameter-expansion))
 
@@ -327,16 +327,20 @@ checks:
 <p>
 <details>
 <summary><strong><u>AWS</u></strong> resources exist and are securely setup
-  (<a href="https://geomancy.readthedocs.io/en/latest/usage/format.html#checkawss3">checkS3</a>)
+  (<a href="https://geomancy.readthedocs.io/en/latest/usage/checks/aws/index.html">AWS checks</a>)
 </summary>
 
 The following shows an example in yaml format. Checks can be formatted in
 toml format as well.
 
 ```yaml
 AWS:
+  IAM:
+    desc: Check the default authentication and security settings
+    checkIAM:
+
   TemplatesS3Bucket:
-    desc: The bucket for cloudformation templates
+    desc: Check the bucket for cloudformation templates
     checkS3: "myproject-cfn-templates"
 ```
 </details>
@@ -384,14 +388,16 @@ AWS:
 2. Use ``geo`` to run the checks.
 
     ```shell
-    $ geo check
-    [✔] .geomancy.yaml...passed
+    [✔] test.yaml...passed
     [✔]   checks...passed
     [✔]     Environment...passed
-    [✔]       Check environment variable '$USER'......passed
+    [✔]       Check environment variable '$USER'...passed
     [✔]     Paths...passed
-    [✔]       Check path 'examples/geomancy.toml'......passed
-    [✔]       Check path 'examples/pyproject.toml'......passed
+    [✔]       Check path 'examples/geomancy.toml'...passed
+    [✔]       Check path 'examples/pyproject.toml'...passed
+    [✔]     Executables...passed
+    [✔]       Check executable 'python3>=3.11'...passed
+    ================================= 9 passed in 0.51s ==================================
     ```
 
     (By default, ``geomancy`` will search ``.geomancy.y[a]ml``, ``geomancy.y[a]ml``
@@ -408,6 +414,13 @@ For full documentation please see https://geomancy.readthedocs.io/en/latest.
 Please use the [GitHub issue tracker](https://github.com/jlorieau/geomancy/issues)
 to submit bugs or request features.
 
+## Similar projects
+
+The following projects share some of the same goals in different contexts:
+
+- [Envalid](https://github.com/af/envalid)
+- [AWS Config](https://aws.amazon.com/config/)
+
 ## License
 
 Copyright Justin Lorieau and others, 2023.

changelog/_template.rst

@@ -0,0 +1,43 @@
+{% if render_title %}
+{% if versiondata.name %}
+{{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
+{% else %}
+{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
+{% endif %}
+{% endif %}
+{% for section, _ in sections.items() %}
+{% set underline = underlines[0] %}{% if section %}{{section}}
+{{ underline * section|length }}{% set underline = underlines[1] %}
+
+{% endif %}
+
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section]%}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ values|join(', ') }}. {{ text }}{% if values %}{% endif %}
+
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}
+{% endfor %}

docs/_static/custom.css

@@ -17,8 +17,20 @@ h2 {
 
 h3 {
     font-size: 1.25em;
+    margin: 1em 0;
+    padding-left: 0;
 }
 
 h4, h5, h6 {
     font-size: 1.0em;
 }
+
+/* Format sequential definition lists to display together--no extra spaces */
+dl {
+    margin-block-start: 0;
+    margin-block-end: 0;
+}
+
+dd {
+    margin-block-start: 0.25em;
+}

docs/about/api/index.rst

@@ -16,7 +16,8 @@ Checks
     geomancy.checks.CheckPath
     geomancy.checks.CheckPlatform
     geomancy.checks.CheckPythonPackage
-    geomancy.checks.CheckAWSS3
+    geomancy.checks.aws.CheckAwsS3
+    geomancy.checks.aws.CheckAwsIam
 
 Config
 ------