Merge pull request #4 from AndreWohnsland/dev

Interactive add fix

Author: AndreWohnsland

README.md

@@ -56,4 +56,4 @@ If you want to have a complete walkthrough, you can have a look at the [usage do
 
 Here you can see an example of the generated skill plot:
 
-![skillist](https://github.com/AndreWohnsland/skillplotter/blob/master/docs/skills_example.png?raw=true)
+![skillist](https://github.com/AndreWohnsland/skillplotter/blob/master/docs/img/skills_example.png?raw=true)

docs/img/skills_example.png

@@ -17,4 +17,4 @@ Here you will find everything to get started!
 
 A small example:
 
-![skillist](skills_example.png "your skillist")
+![skillist](img/skills_example.png "your skillist")

docs/index.md

@@ -3,7 +3,7 @@
 In this section, you will get a brief introduction to the usage of the package.
 If you want to have deeper insight into the functionality of the functions, you can always use the `--help` flag.
 
-!!! note
+!!! note "Easy Start"
     This package is quite flexible, but the base case is quite easy.
     So if you want a fast test, use `skill-plotter add` and then `skill-plotter` to see first results. 
 
@@ -145,6 +145,10 @@ skill-plotter -c
 This will group the skills by your defined categories, as well the skills will be sorted within the category by decreasing level.
 If the default category exist, skills within this category will be shown first.
 
+!!! tip "Non-Alphabetical Order"
+    You can also use numbers for your categories to order them by increasing number.
+    This is useful if you want a specific, non-alphabetical order of the categories.
+
 This will use the skill group `group1` to plot the skills.
 
 ### Defining the Output File
@@ -168,6 +172,7 @@ Some options are:
 - `--bar-color`: The color of the bars in the plot
 - `--bg-color`: The color of the background bars in the plot
 - `--font-color`: The color of the font in the plot
+- `--canvas-color`: The color behind the plot
 
 You can experiment with those values and find the best fit for you.
 I recommend using hex color codes for the colors.

docs/skills_example.png

@@ -38,11 +38,10 @@ def main(
     background_height: Annotated[
         float, typer.Option("--bg-height", help="Height of the bars background", min=0, max=1)
     ] = 0.7,
-    bar_color: Annotated[str, typer.Option("--bar-color", help="Color of the bar", min=0, max=1)] = BLUE,
-    background_color: Annotated[
-        str, typer.Option("--bg-color", help="Color of the bars background", min=0, max=1)
-    ] = DARK_GRAY,
-    font_color: Annotated[str, typer.Option("--font-color", help="Color of the font", min=0, max=1)] = DARK_GRAY,
+    bar_color: Annotated[str, typer.Option("--bar-color", help="Color of the bar")] = BLUE,
+    background_color: Annotated[str, typer.Option("--bg-color", help="Color of the bars background")] = DARK_GRAY,
+    font_color: Annotated[str, typer.Option("--font-color", help="Color of the font")] = DARK_GRAY,
+    canvas_color: Annotated[Optional[str], typer.Option(help="Color behind the plot")] = None,
     version: Annotated[Optional[bool], typer.Option("--version", "-V", callback=version_callback)] = None,
 ):
     """
@@ -58,11 +57,11 @@ def main(
     data = preparator.read_file(skill_group)
     if group_categories:
         data = preparator.sort_skills_by_category(data)
-    typer.echo(data)
     plot_data = preparator.reduce_data(data)
     generate_skill_picture(
         plot_data, columns, save_name, file_type, bar_height,
-        background_height, background_color, bar_color, font_color
+        background_height, background_color, bar_color, font_color,
+        canvas_color,
     )
 
 

docs/usage.md

@@ -1,6 +1,7 @@
 import matplotlib.pyplot as plt
 from matplotlib.axes import Axes
-from typing import Union
+from typing import Union, Optional
+
 
 from .preparator import split_dict_evenly
 
@@ -65,7 +66,6 @@ def generate_diagram(
     ax.spines["top"].set_visible(False)
     ax.spines["left"].set_visible(False)
     ax.spines["right"].set_visible(False)
-    # plt.setp(ax.get_xticklabels(), color="w", fontsize=8)
     ax.get_xaxis().set_visible(False)
 
 
@@ -79,6 +79,7 @@ def generate_skill_picture(
     background_color: _COLOR = DARK_GRAY,
     bar_color: _COLOR = DARK_GRAY,
     font_color: _COLOR = BLUE,
+    canvas_color: Optional[_COLOR] = None,
 ):
     """Generate a bar diagram for the given skills.
 
@@ -99,7 +100,7 @@ def generate_skill_picture(
     # generate the diagram, splits the values into two lists to plot.
     # this should be done in the future over one loop
     # the loop decides what to put when and how many columns
-    _, axes = plt.subplots(1, n_splits, figsize=(10 * n_splits, split_len))
+    fig, axes = plt.subplots(1, n_splits, figsize=(10 * n_splits, split_len))
 
     # will get an iterable error since when using only one column, axes is not a list
     # just put the Axes object into a list to fix this
@@ -108,5 +109,15 @@ def generate_skill_picture(
 
     for ax, skills in zip(axes, split_skills):
         generate_diagram(ax, skills, bar_height, background_height, background_color, bar_color, font_color)
+        # need also to set face color of each axis
+        if canvas_color is not None:
+            ax.set_facecolor(canvas_color)
+    # set the facecolor of the canvas to the given color
+    extra_args = {}
+    if canvas_color is not None:
+        fig.set_facecolor(canvas_color)
+    # only transparent if there is no canvas color
+    else:
+        extra_args["transparent"] = True
     plt.tight_layout()
-    plt.savefig(f"{save_name}.{file_type}", format=file_type, transparent=True)
+    plt.savefig(f"{save_name}.{file_type}", format=file_type, **extra_args)

skill_plotter/main.py

@@ -51,7 +51,7 @@ def sort_skills_by_category(skills: dict[str, dict[str, Any]]) -> dict[str, dict
     return dict(
         sorted(
             skills.items(),
-            key=lambda x: (x[1]["category"] != _DEFAULT_CATEGORY, x[1]["category"], x[1]["level"])
+            key=lambda x: (x[1]["category"] != _DEFAULT_CATEGORY, x[1]["category"], -x[1]["level"])
         )
     )
 
@@ -99,21 +99,29 @@ def add_skill(
 
 def interactive_add_skill(
     file_name: str = DEFAULT_SKILL_FILE_NAME,
-    category: Optional[str] = None,
+    used_category: Optional[str] = None,
 ):
     """Interactively adds skills to the skill list."""
     info_print(f"Using interactive mode, use Ctrl+C to exit, skills will be added to {file_name}")
-    if category is not None:
-        info_print(f"Using category {category}")
+    if used_category is not None:
+        info_print(f"Using category {used_category}")
     while True:
         skill = typer.prompt("Enter skill name")
-        level = typer.prompt("Enter level", type=float)
-        if category is None:
+        level = 0
+        while level <= 0 or level > 10:
+            level = typer.prompt("Enter level [0-10]", type=float)
+            if level <= 0 or level > 10:
+                failure_print("Level must be between 0 and 10 and not 0")
+        if used_category is None:
             category = typer.prompt("Enter category", default=_DEFAULT_CATEGORY)
+        else:
+            category = used_category
         # this should usually not be happening, but just in case
         if not category:
             category = _DEFAULT_CATEGORY
         add_skill(skill, level, category, file_name)
+        # need to reset category!
+        category = None
 
 
 def remove_skill(skill: str, file_name: str = DEFAULT_SKILL_FILE_NAME):