Code flake linted and all instructions for --use-pep517 (#498)

Author: JohnPreston

.editorconfig

@@ -16,6 +16,9 @@ indent_size = 2
 [*.yaml]
 indent_size = 2
 
+[*.json]
+indent_size = 2
+
 [*.toml]
 indent_size = 2
 

Makefile

@@ -113,22 +113,21 @@ servedocs: docs ## compile the docs watching for changes
 
 release: dist ## package and upload a release
 	twine check dist/*
-	twine upload dist/*
+	poetry publish --build
 
 release-test: dist ## package and upload a release
 	twine check dist/* || echo Failed to validate release
-	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-
+	poetry config repositories.pypitest https://test.pypi.org/legacy/
+	poetry publish -r pypitest --build
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	poetry build
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+	pip install . --use-pep517 --use-feature=in-tree-build
 
 conform	: ## Conform to a standard of coding syntax
 	isort --profile black ecs_composex
-	black ecs_composex tests setup.py
+	black ecs_composex tests
 	find ecs_composex -name "*.json" -type f  -exec sed -i '1s/^\xEF\xBB\xBF//' {} +

cli.Dockerfile

@@ -6,7 +6,7 @@ FROM $BASE_IMAGE as builder
 
 WORKDIR /opt
 COPY ecs_composex       /opt/ecs_composex
-COPY setup.py pyproject.toml MANIFEST.in README.rst LICENSE /opt/
+COPY pyproject.toml poetry.lock MANIFEST.in README.rst LICENSE /opt/
 RUN python -m pip install pip -U ; pip install poetry ; poetry build
 
 FROM $BASE_IMAGE

docs/installation.rst

@@ -12,8 +12,8 @@ Installation
 Stable release
 ==============
 
-From docker
-------------
+Using docker
+-------------
 
 .. code-block:: console
 
@@ -26,6 +26,14 @@ From docker
 From Pip
 ---------
 
+.. warning::
+
+    You must use pip>=21 to have all functionalities work. Simply run
+
+    .. code-block::
+
+        pip install pip -U
+
 To install ECS-Compose-X, run this command in your terminal:
 
 .. code-block:: console
@@ -40,6 +48,8 @@ To install ECS-Compose-X, run this command in your terminal:
 
         python -m venv venv
         source venv/bin/activate
+        pip install pip -U
+        pip install ecs_composex
 
 This is the preferred method to install ECS-Compose-X, as it will always install the most recent stable release.
 
@@ -74,7 +84,10 @@ Using pip
 
     # After git clone
     cd ecs_composex
-    pip install .
+    python -m venv venv
+    source venv/bin/activate
+    pip install pip -U
+    pip install . --use-pep517 --use-feature=in-tree-build
 
 Using poetry
 -------------------
@@ -83,7 +96,10 @@ Using poetry
 
     # After git clone
     cd ecs_composex
-    python -m pip install poetry
+    python -m venv venv
+    source venv/bin/activate
+    pip install pip -U
+    pip install poetry
     poetry install
 
 .. hint::

ecs_composex/alarms/alarms_ecs.py

@@ -14,7 +14,7 @@
 from ecs_composex.alarms.alarms_stack import Alarm, create_alarms
 from ecs_composex.common import LOG, add_outputs, add_parameters
 from ecs_composex.common.cfn_params import Parameter
-from ecs_composex.ecs.ecs_params import CLUSTER_NAME, SERVICE_SCALING_TARGET, SERVICE_T
+from ecs_composex.ecs.ecs_params import CLUSTER_NAME, SERVICE_SCALING_TARGET
 from ecs_composex.ecs.ecs_scaling import (
     generate_alarm_scaling_out_policy,
     reset_to_zero_policy,

ecs_composex/alarms/alarms_stack.py

@@ -9,21 +9,12 @@
 import re
 
 from compose_x_common.compose_x_common import keyisset
-from troposphere import (
-    AWS_REGION,
-    AWS_STACK_ID,
-    AWS_STACK_NAME,
-    Join,
-    Ref,
-    Select,
-    Split,
-    Sub,
-)
+from troposphere import AWS_REGION, AWS_STACK_ID, Join, Ref, Select, Split, Sub
 from troposphere.cloudwatch import Alarm as CWAlarm
 from troposphere.cloudwatch import CompositeAlarm
 
 from ecs_composex.alarms.alarms_params import RES_KEY
-from ecs_composex.common import LOG, build_template
+from ecs_composex.common import build_template
 from ecs_composex.common.compose_resources import XResource, set_resources
 from ecs_composex.common.stacks import ComposeXStack
 from ecs_composex.resources_import import import_record_properties

ecs_composex/codeguru_profiler/codeguru_profiler_aws.py

@@ -8,8 +8,6 @@
 
 import re
 
-from botocore.exceptions import ClientError
-
 from ecs_composex.codeguru_profiler.codeguru_profiler_params import (
     PROFILER_ARN,
     PROFILER_NAME,

ecs_composex/codeguru_profiler/codeguru_profiler_ecs.py

@@ -18,8 +18,9 @@
 def define_lookup_profile_mappings(mappings, resources, settings):
     """
     Function to update the mappings of CodeGuru profile identified via Lookup
-    :param mappings:
-    :param resources:
+    :param dict mappings:
+    :param list resources:
+    :param ecs_composex.common.settings.ComposeXSettings settings:
     :return:
     """
     for res in resources:

ecs_composex/codeguru_profiler/codeguru_profiler_perms.json

@@ -1,9 +1,9 @@
 {
-    "RW": {
-        "Effect": "Allow",
-        "Action": [
-            "codeguru-profiler:ConfigureAgent",
-            "codeguru-profiler:PostAgentProfile"
-        ]
-    }
+  "RW": {
+    "Effect": "Allow",
+    "Action": [
+      "codeguru-profiler:ConfigureAgent",
+      "codeguru-profiler:PostAgentProfile"
+    ]
+  }
 }

ecs_composex/codeguru_profiler/codeguru_profiler_stack.py

@@ -7,16 +7,7 @@
 """
 
 from compose_x_common.compose_x_common import keyisset
-from troposphere import (
-    AWS_NO_VALUE,
-    AWS_PARTITION,
-    AWS_REGION,
-    AWS_STACK_NAME,
-    GetAtt,
-    Join,
-    Ref,
-    Sub,
-)
+from troposphere import GetAtt, Ref, Sub
 from troposphere.codeguruprofiler import ProfilingGroup
 
 from ecs_composex.codeguru_profiler.codeguru_profiler_params import (