Merge remote-tracking branch 'origin/develop'

Signed-off-by: Lunik <[email protected]>

Author: Lunik

.gitignore

@@ -5,4 +5,6 @@ build
 dist
 .task
 .pytest_cache
-.checks
+.checks
+.coverage
+.DS_Store

.pylintrc

@@ -330,11 +330,11 @@ expected-line-ending-format=
 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
 
 # Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=2
+indent-after-paren=4
 
 # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
 # tab).
-indent-string='  '
+indent-string='    '
 
 # Maximum number of characters on a single line.
 max-line-length=120

CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## v0.3.0
+
+### Features
+
+- Add `self` collection with `upgrade` module
+- Add `python` collection with `venv-create`, `venv-cleanup` modules
+
+### Fixes
+
+- Ensure that all `dist` files are removed before building a new one
+
+
 ## v0.2.1
 
 ### Fixes

README.md

@@ -12,6 +12,16 @@ To install LaFlem, simply run the following command:
 pip install --user laflem
 ```
 
+or with an isolated environment:
+
+```bash
+python -m venv ~/bin/laflem_venv
+~/bin/laflem_venv/bin/pip install laflem
+
+ln -s ~/bin/laflem_venv/bin/laflem ~/bin/laflem
+ln -s ~/bin/laflem_venv/bin/lf ~/bin/lf
+```
+
 ## Usage
 
 To use LaFlem, simply run the following command :

Taskfile.yml

@@ -10,8 +10,10 @@ vars:
   PIP_BIN: "{{ .VENV_DIR }}/bin/pip3"
   PYTEST_BIN: "{{ .VENV_DIR }}/bin/pytest"
   PYLINT_BIN: "{{ .VENV_DIR }}/bin/pylint"
+  BLACK_BIN: "{{ .VENV_DIR }}/bin/black"
   TWINE_BIN: "{{ .VENV_DIR }}/bin/twine"
   FLEM_BIN: "{{ .VENV_DIR }}/bin/laflem"
+  COVERAGE_BIN: "{{ .VENV_DIR }}/bin/coverage"
 
 tasks:
   venv:
@@ -86,6 +88,7 @@ tasks:
     deps: [ venv, install-dev ]
     desc: Build and compile the application
     cmds:
+      - rm -rf dist
       - >
         {{ .PYTHON_BIN }}
         -m build
@@ -112,6 +115,13 @@ tasks:
     deps: [ venv, install-dev, check_folder ]
     desc: Run pylint on the application
     cmds:
+      - >
+        {{ .BLACK_BIN }}
+        --check
+        lib setup.py
+        | 
+        tee
+        "{{ .CHECKS_DIR }}/black.result.txt"
       - >
         {{ .PYLINT_BIN }}
         lib setup.py
@@ -123,6 +133,7 @@ tasks:
       - tests/**/*
       - setup.py
     generates:
+      - "{{ .CHECKS_DIR }}/black.result.txt"
       - "{{ .CHECKS_DIR }}/pylint.result.txt"
 
   test:
@@ -133,11 +144,34 @@ tasks:
         vars:
           PACKAGE: dist/{{ .NAME }}-*.tar.gz
       - >
-        {{ .PYTEST_BIN }}
-        tests
+        {{ .PYTHON_BIN }}
+        -m pytest
+        -v
+        -n 4
+        --cov={{ .NAME }}
+        --junitxml="{{ .CHECKS_DIR }}/result.xml"
+        --html="{{ .CHECKS_DIR }}/report.html"
+        "tests/{{ .NAME }}"
+      - >
+        {{ .COVERAGE_BIN }}
+        html
+        -d "{{ .CHECKS_DIR }}/htmlcov"
+      - >
+        {{ .COVERAGE_BIN }}
+        xml
+        -o "{{ .CHECKS_DIR }}/coverage.xml"
       - task: uninstall-package
         vars:
           PACKAGE: "{{ .NAME }}"
+      #- open "{{ .CHECKS_DIR }}/report.html"
+      #- open "{{ .CHECKS_DIR }}/htmlcov/index.html"
+    sources:
+      - lib/**/*
+      - tests/**/*
+      - setup.py
+    generates:
+      - "{{ .CHECKS_DIR }}/result.xml"
+      - "{{ .CHECKS_DIR }}/coverate.xml"
 
   package_check:
     internal: true
@@ -192,6 +226,7 @@ tasks:
         lib/*.egg-info
         "{{ .CHECKS_DIR }}"
         .pytest_cache
+        .coverage
 
   run-dev:
     deps: [ install ]

lib/laflem/__init__.py

@@ -1,39 +1,39 @@
-'''
+"""
 Main module for laflem
-'''
+"""
 import sys
 
 from .flem import Flem
 from .exceptions import FlemException
 from .log import error_console
 
-__version__ = '0.2.1'
+__version__ = "0.3.0"
+
 
 def main():
-  '''
-  Main function for laflem.
-  '''
-  flem = Flem(
-    version=__version__
-  )
-  args = flem.parser.parse_args()
-
-  try:
-    if args.collection:
-      collection = flem.get_collection(args.collection)
-      if args.module:
-        module = collection.get_module(args.module)
-
-        module.run(**args.__dict__)
-        sys.exit(0)
-
-  except Exception as error: # pylint: disable=broad-except
-    if isinstance(error, FlemException):
-      error_console.print(error, style="bold red")
-    else:
-      error_console.print_exception()
-
-    sys.exit(1)
-
-if __name__ == '__main__':
-  main()
+    """
+    Main function for laflem.
+    """
+    flem = Flem(version=__version__)
+    args = flem.parser.parse_args()
+
+    try:
+        if args.collection:
+            collection = flem.get_collection(args.collection)
+            if args.module:
+                module = collection.get_module(args.module)
+
+                module.run(**args.__dict__)
+                sys.exit(0)
+
+    except Exception as error:  # pylint: disable=broad-except
+        if isinstance(error, FlemException):
+            error_console.print(error, style="bold red")
+        else:
+            error_console.print_exception()
+
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

lib/laflem/collections/base/__init__.py

@@ -1,34 +1,36 @@
-'''
+"""
 Define the base collection with basic functionality.
-'''
+"""
 from laflem.exceptions import ModuleNotFound
 
 from .helloworld import HelloWorldModule
 from .ask import AskModule
 
+
 class BaseCollection:
-  '''
-  The base collection.
-  '''
-  name = "base"
-  description = "Base collection with basic functionality."
-  modules = {
-    'helloworld': HelloWorldModule,
-    'ask': AskModule,
-  }
+    """
+    The base collection.
+    """
+
+    name = "base"
+    description = "Base collection with basic functionality."
+    modules = {
+        "helloworld": HelloWorldModule,
+        "ask": AskModule,
+    }
 
-  def get_module(self, name):
-    '''
-    Return an instance of the requested module if it exists.
-    Else raise a ModuleNotFound exception.
-    '''
-    if name in self.modules:
-      return self.modules[name]()
+    def get_module(self, name):
+        """
+        Return an instance of the requested module if it exists.
+        Else raise a ModuleNotFound exception.
+        """
+        if name in self.modules:
+            return self.modules[name]()
 
-    raise ModuleNotFound(name)
+        raise ModuleNotFound(name)
 
-  @classmethod
-  def build_parser(cls, parser):
-    '''
-    Add arguments to the parser or options.
-    '''
+    @classmethod
+    def build_parser(cls, parser):
+        """
+        Add arguments to the parser or options.
+        """

lib/laflem/collections/base/ask.py

@@ -1,29 +1,31 @@
-'''
+"""
 Define the ask module.
 This module is used to ask the user about him.
 This is a demonstration module.
-'''
+"""
 from rich.prompt import Prompt
 
 from laflem.log import console
 from .helloworld import HelloWorldModule
 
+
 class AskModule(HelloWorldModule):
-  '''
-  The ask module.
-  '''
-  name = "ask"
-  description = "Ask the user about him."
-  version = "0.1.0"
+    """
+    The ask module.
+    """
+
+    name = "ask"
+    description = "Ask the user about him."
+    version = "0.1.0"
 
-  def _main(self, *_args, **_kwargs):
-    '''
-    Core the module.
-    '''
-    name = None
-    while not name:
-      name = Prompt.ask('Please provide your [bold red]name[/]')
-      if not name:
-        console.print("Please enter your name.", style="blue")
+    def _main(self, *_args, **_kwargs):
+        """
+        Core the module.
+        """
+        name = None
+        while not name:
+            name = Prompt.ask("Please provide your [bold red]name[/]")
+            if not name:
+                console.print("Please enter your name.", style="blue")
 
-    console.print(f"Hello, {name} !", style="green")
+        console.print(f"Hello, {name} !", style="green")