feat: Add CLI option --emojis to change README header prefixes

CHANGELOG.md

@@ -15,6 +15,10 @@
 
 All notable changes to the *readme-ai* project will be documented in this file.
 
+---
+## [v0.1.6] - *2023-10-20*
+
+
 ---
 
 ## [v0.1.5] - *2023-10-15*

README.md

@@ -495,17 +495,18 @@ poetry install
 
 To generate a *README.md* file, use the `readmeai` command in your terminal, along with the arguments below.
 
-| Short Flag | Long Flag      | Description                                         | Status       |
-|------------|----------------|-----------------------------------------------------|--------------|
-| `-k`       | `--api-key`    | Your language model API secret key.                 | Optional     |
-| `-b`       | `--badges`     | Select 'shields' or 'square' to change badge style. | Optional     |
-| `-f`       | `--offline-mode`| Run offline without calling the OpenAI API.        | Optional     |
-| `-m`       | `--model`      | Large language model engine (gpt-3.5-turbo)         | Optional     |
-| `-o`       | `--output`     | The output path for your README.md file.            | Optional     |
-| `-r`       | `--repository` | The URL or path to your code repository.            | Required     |
-| `-t`       | `--temperature`| The temperature (randomness) of the model.          | Optional     |
-| `-l`       | `--language`   | The language of text to write README in.            | Coming Soon! |
-| `-s`       | `--style`      | The README template style to build.                 | Coming Soon! |
+| Short Flag | Long Flag        | Description                                         | Type   | Status       |
+|------------|------------------|-----------------------------------------------------|-------------|--------------|
+| `-k`       | `--api-key`      | Your language model API secret key.                 | String      | Optional     |
+| `-b`       | `--badges`       | Select 'shields' or 'square' to change badge style. | String      | Optional     |
+| `-e`       | `--emojis`       | Add emojis to your README.md file heading sections  | Boolean     | Optional     |
+| `-f`       | `--offline-mode` | Run offline without calling the OpenAI API.         | Boolean     | Optional     |
+| `-m`       | `--model`        | Large language model engine (gpt-3.5-turbo)         | String      | Optional     |
+| `-o`       | `--output`       | The output path for your README.md file.            | Path/String | Optional     |
+| `-r`       | `--repository`   | The URL or path to your code repository.            | URL/String  | Required     |
+| `-t`       | `--temperature`  | The temperature (randomness) of the model.          | Float       | Optional     |
+| `-l`       | `--language`     | The language of text to write README in.            | String      | Coming Soon! |
+| `-s`       | `--style`        | The README template style to build.                 | String      | Coming Soon! |
 
 <br>
 

pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "readmeai"
-version = "0.4.026"
-description = "🚀 Generate beautiful README.md files from the terminal. Powered by OpenAI's GPT LLMs 💫"
+version = "0.4.027"
+description = "🚀 Generate beautiful README files from the terminal, powered by AI. 💫"
 authors = ["Eli <0x.eli.64s@gmail.com>"]
 license = "MIT"
 readme = "README.md"

readmeai/cli/commands.py

@@ -11,8 +11,7 @@
 @click.command()
 @options.api_key
 @options.badges
-@options.encoding
-@options.endpoint
+@options.emojis
 @options.offline_mode
 @options.model
 @options.output
@@ -23,8 +22,7 @@
 def commands(
     api_key: str,
     badges: Optional[str],
-    encoding: Optional[str],
-    endpoint: Optional[str],
+    emojis: Optional[bool],
     offline_mode: Optional[bool],
     model: Optional[str],
     output: Optional[str],
@@ -37,8 +35,7 @@ def commands(
     main(
         api_key=api_key,
         badges=badges,
-        encoding=encoding,
-        endpoint=endpoint,
+        emojis=emojis,
         offline_mode=offline_mode,
         model=model,
         output=output,

readmeai/cli/options.py

@@ -24,18 +24,12 @@
         - 'shields' refers to badges from shields.io \
         - 'square' refers to app-like square badges.""",
 )
-encoding = click.option(
-    "-c",
-    "--encoding",
-    default="cl100k_base",
-    help="Encoding used to tokenize text.",
+emojis = click.option(
+    "-e",
+    "--emojis",
+    default=True,
+    help="Emojis prefixed to all README heading sections.",
 )
-endpoint = click.option(
-    "--endpoint",
-    default="https://api.openai.com/v1/chat/completions",
-    help="Large language model API endpoint.",
-)
-
 model = click.option(
     "-m",
     "--model",

readmeai/core/config.py

@@ -34,6 +34,12 @@ class ApiConfig(BaseModel):
     offline_mode: bool
 
 
+class CliConfig(BaseModel):
+    """Command-line interface configuration."""
+
+    emojis: bool
+
+
 class GitConfig(BaseModel):
     """Pydantic model for Git repository configuration."""
 
@@ -121,6 +127,7 @@ class AppConfig(BaseModel):
     """Nested Pydantic model for the entire configuration."""
 
     api: ApiConfig
+    cli: CliConfig
     git: GitConfig
     md: MarkdownConfig
     paths: PathsConfig

readmeai/main.py

@@ -25,8 +25,7 @@
 def main(
     api_key: str,
     badges: str,
-    encoding: str,
-    endpoint: str,
+    emojis: bool,
     offline_mode: bool,
     model: str,
     output: str,
@@ -40,6 +39,7 @@ def main(
     config_model = AppConfigModel(app=config)
     config_helper = load_config_helper(config_model)
     config.api.model = model
+    config.cli.emojis = emojis
     config.paths.output = output
     config.api.temperature = temperature
     config.api.offline_mode = offline_mode