fix: Rename project from containers-sugar to sugar and improve docs (#98

)

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-* containers-sugar version:
+* sugar version:
 * Python version:
 * Operating System:
 

.makim.yaml

@@ -24,13 +24,13 @@ groups:
     targets:
       build:
         help: Build the documentation
-        run: mkdocs build --config-file docs/mkdocs.yaml
+        run: mkdocs build --config-file mkdocs.yaml
 
       preview:
         help: Preview the documentation
         dependencies:
-          - target: docs-build
-        run: mkdocs serve --watch docs --config-file docs/mkdocs.yam
+          - target: docs.build
+        run: mkdocs serve --watch docs --config-file mkdocs.yaml
 
   package:
     help: helper commands for handling the package

.pre-commit-config.yaml

@@ -34,7 +34,7 @@ repos:
       name: mypy
       entry: mypy
       language: system
-      files: "src/containers_sugar/"
+      files: "src/sugar/"
       pass_filenames: true
       types:
         - python
@@ -52,7 +52,7 @@ repos:
       name: vulture
       entry: vulture
       language: system
-      files: "src/containers_sugar/"
+      files: "src/sugar/"
       description: Find unused Python code.
       pass_filenames: true
       types:

.releaserc.json

@@ -8,12 +8,12 @@
       {
         "replacements": [
           {
-            "files": ["src/containers_sugar/__init__.py"],
+            "files": ["src/sugar/__init__.py"],
             "from": "__version__ = '.*'  # semantic-release",
             "to": "__version__ = '${nextRelease.version}'  # semantic-release",
             "results": [
               {
-                "file": "src/containers_sugar/__init__.py",
+                "file": "src/sugar/__init__.py",
                 "hasChanged": true,
                 "numMatches": 1,
                 "numReplacements": 1
@@ -65,7 +65,7 @@
         "assets": [
           "pyproject.toml",
           "docs/changelog.md",
-          "src/containers_sugar/__init__.py"
+          "src/sugar/__init__.py"
         ],
         "message": "chore(release): ${nextRelease.version}"
       }

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
-  "python.formatting.blackPath": "/home/xmn/mambaforge/envs/containers-sugar/bin/blue",
+  "python.formatting.blackPath": "/home/xmn/mambaforge/envs/sugar/bin/blue",
   "python.formatting.provider": "black"
 }

README.md

@@ -1,4 +1,4 @@
-# containers-sugar
+# sugar
 
 Simplify the usage of containers.
 
@@ -23,7 +23,7 @@ configuration file. So the command line would be very simple.
 
 
 * Free software: BSD 3 Clause
-* Documentation: https://osl-incubator.github.io/containers-sugar
+* Documentation: https://osl-incubator.github.io/sugar
 
 
 ## Features
@@ -68,7 +68,7 @@ The current available **ext** commands are:
 
 ## How to use it
 
-First you need to place the config file `.containers-sugar.yaml` in the root
+First you need to place the config file `.sugar.yaml` in the root
 of your project. This is an example of a configuration file:
 
 ```yaml
@@ -100,10 +100,10 @@ groups:
         - name: service1
 ```
 
-**NOTE**: containers-sugar has an convenient alias `sugar` that helps to
+**NOTE**: sugar has an convenient alias `sugar` that helps to
 keep the command line shorter, where **k** stands for *containers*,
 **x** stands for *su* (*shu* sound), and **gr** stands for *gar*.
-In another words, you can use `containers-sugar` or `sugar` CLI.
+In another words, you can use `sugar` or `sugar` CLI.
 
 Some examples of how to use it: