Cleanup to the project (#116)

* fixes * format * fixes: add missing filters to docs
Skyscanner · Apr 6, 2020 · 6b946e9 · 6b946e9
1 parent 63f4dd4
commit 6b946e9
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 39 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,19 +1,15 @@
-# .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Build documentation with MkDocs
 mkdocs:
   configuration: mkdocs.yml
 
-# Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
 python:
   version: 3.7
   install:
-    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
+        - docs
diff --git a/Makefile b/Makefile
@@ -43,7 +43,7 @@ freeze:
 	CUSTOM_COMPILE_COMMAND="make freeze" pip-compile --no-index --output-file requirements.txt setup.py
 
 freeze-upgrade:
-	CUSTOM_COMPILE_COMMAND="make freeze" pip-compile --no-index --upgrade --output-file requirements.txt setup.py
+	CUSTOM_COMPILE_COMMAND="make freeze-upgrade" pip-compile --no-index --upgrade --output-file requirements.txt setup.py
 
 lambda.zip: $(SOURCES) Makefile requirements.txt
 	if [ -f lambda.zip ]; then rm lambda.zip; fi

diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/rule_config.md b/docs/rule_config.md
@@ -42,6 +42,8 @@ Rule Standard -> Rule Config -> Filter #1 -> ... -> Filter #N
 | `and`      | True if all args are True                                                   | `{"and": [True, True]}`                 |
 | `in`       | Same as a in b                                                              | `{"in": ["b", ["a", "b"]]}`             |
 | `regex`    | True if b match pattern a                                                   | `{"regex": [r"^\d+$", "5"]}`            |
+| `exists`   | True if a is not None                                                       | `{"exists": None}`                      |
+| `empty`    | True if len(a) equals 0                                                     | `{"empty": []}`                         |
 | `ref`      | Get the value at any depth of the context based on the path described by a. | `{"ref": "param_a.param_b"}`            |
 
 ### Examples

diff --git a/requirements.txt b/requirements.txt
@@ -2,12 +2,12 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    make freeze
+#    make freeze-upgrade
 #
-boto3==1.12.29            # via cfripper (setup.py)
-botocore==1.15.29         # via boto3, s3transfer
+boto3==1.12.35            # via cfripper (setup.py)
+botocore==1.15.35         # via boto3, s3transfer
 cfn-flip==1.2.2           # via cfripper (setup.py)
-click==7.1.1              # via cfn-flip
+click==7.1.1              # via cfn-flip, cfripper (setup.py)
 docutils==0.15.2          # via botocore
 jmespath==0.9.5           # via boto3, botocore
 pycfmodel==0.7.0          # via cfripper (setup.py)

diff --git a/setup.py b/setup.py
@@ -6,7 +6,14 @@
 
 project_root_path = Path(__file__).parent
 
-install_requires = ["boto3>=1.4.7,<2", "cfn_flip>=1.2.0", "pycfmodel>=0.7.0", "pydash~=4.7.6", "PyYAML>=4.2b1"]
+install_requires = [
+    "boto3>=1.4.7,<2",
+    "cfn_flip>=1.2.0",
+    "click~=7.1.1",
+    "pycfmodel>=0.7.0",
+    "pydash~=4.7.6",
+    "PyYAML>=4.2b1",
+]
 
 dev_requires = [
     "black==19.10b0",