developer-assistant 0.3.0__tar.gz → 0.3.5__tar.gz

{developer_assistant-0.3.0/developer_assistant.egg-info → developer_assistant-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: developer-assistant
-Version: 0.3.0
+Version: 0.3.5
 Summary: A lightweight TUI app for managing and simplifying your Markdown changelogs.
 License: The MIT License (MIT)
         
@@ -12,11 +12,8 @@ License: The MIT License (MIT)
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 Project-URL: Homepage, https://github.com/Ivory-Hubert/Developer-Assistant
-Project-URL: Repository, https://github.com/Ivory-Hubert/Developer-Assistant.git
-Project-URL: Issues, https://github.com/Ivory-Hubert/Developer-Assistant/issues
 Project-URL: Changelog, https://github.com/Ivory-Hubert/Developer-Assistant/blob/main/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -32,6 +29,9 @@ Dynamic: license-file
 # Developer Assistant
 
 ## Installing from PyPI
+
+The program is designed for minimal friction and simple setup. Only installation is required, on first run DA will create local user data automatically. The same process is used for new profiles.
+
 **Using uv:**
 `uv tool install developer-assistant`
 
@@ -53,17 +53,18 @@ A. **Using uv:** `uv tool upgrade developer-assistant`
 
 B. **Using pip:** `python -m pip install -U developer-assistant`
 
+
 ## Introduction
 
 ### What does this tool do?
-Developer Assistant is a lightweight TUI app for simplifying and managing your changelogs. You can customize the templates for each profile to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
+Developer Assistant is a lightweight TUI for simplifying and managing your changelogs. You can customize the templates for **each profile** to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
 
-You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are and what's the last version number.
+You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are, which profile owns them and what's the last version number.
 
 Your files are kept safe at all times. Before adding new changes, your existing `CHANGELOG.md` is automatically backed up. While editing, all changes are written to a temporary file first and only prepended to & replaced with your real changelog once you confirm them.
 
 
-## Using the program.
+### Using the program.
 1. **What *not* to do**
 
 Don't change the folder structure or modify variable names inside `.ini` files.
@@ -88,14 +89,33 @@ The program comes with the "Default" profile, you can choose to either stick wit
 
 Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
 
+---
+
 **Customizable templates**
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
+Templates come in three flavours:
+
+* changelog_template.txt - *Changelog title*
+
+* header_template.txt - *Version and date*
+
+* entry_template.txt - *Change entry and comments*
+
+
 **Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
+[Project.ini example](./documents/project-example.ini)
+
+The `command` variable is a custom command that DA will run in your project folder once you choose "Format & commit" in `Main menu / Projects / Project menu / Changelog`. Even when provided, it is **not** run without your confirmation, first it's printed with the folder name and you can choose to skip it.
+
+`owner` & `edited` are filled out automatically when a new project is created and `edited` updates with every changelog update.
+
+---
+
 **Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
@@ -104,10 +124,12 @@ New changes are first written to a temporary file and only prepended to & replac
 This ensures your existing changelog is never overwritten or corrupted, and you always have a fallback copy.
 If the temporary changelog is present on startup you are prompted to remove or keep it.
 
+
 **Ease of navigation**
 
 You can access files/folders and configuration straight from the menus, so you shouldn't find yourself searching through the program's directory or even your local user data very often.
 
+
 **Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/PYPI.md

@@ -1,6 +1,9 @@
 # Developer Assistant
 
 ## Installing from PyPI
+
+The program is designed for minimal friction and simple setup. Only installation is required, on first run DA will create local user data automatically. The same process is used for new profiles.
+
 **Using uv:**
 `uv tool install developer-assistant`
 
@@ -22,17 +25,18 @@ A. **Using uv:** `uv tool upgrade developer-assistant`
 
 B. **Using pip:** `python -m pip install -U developer-assistant`
 
+
 ## Introduction
 
 ### What does this tool do?
-Developer Assistant is a lightweight TUI app for simplifying and managing your changelogs. You can customize the templates for each profile to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
+Developer Assistant is a lightweight TUI for simplifying and managing your changelogs. You can customize the templates for **each profile** to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
 
-You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are and what's the last version number.
+You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are, which profile owns them and what's the last version number.
 
 Your files are kept safe at all times. Before adding new changes, your existing `CHANGELOG.md` is automatically backed up. While editing, all changes are written to a temporary file first and only prepended to & replaced with your real changelog once you confirm them.
 
 
-## Using the program.
+### Using the program.
 1. **What *not* to do**
 
 Don't change the folder structure or modify variable names inside `.ini` files.
@@ -57,14 +61,33 @@ The program comes with the "Default" profile, you can choose to either stick wit
 
 Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
 
+---
+
 **Customizable templates**
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
+Templates come in three flavours:
+
+* changelog_template.txt - *Changelog title*
+
+* header_template.txt - *Version and date*
+
+* entry_template.txt - *Change entry and comments*
+
+
 **Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
+[Project.ini example](./documents/project-example.ini)
+
+The `command` variable is a custom command that DA will run in your project folder once you choose "Format & commit" in `Main menu / Projects / Project menu / Changelog`. Even when provided, it is **not** run without your confirmation, first it's printed with the folder name and you can choose to skip it.
+
+`owner` & `edited` are filled out automatically when a new project is created and `edited` updates with every changelog update.
+
+---
+
 **Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
@@ -73,10 +96,12 @@ New changes are first written to a temporary file and only prepended to & replac
 This ensures your existing changelog is never overwritten or corrupted, and you always have a fallback copy.
 If the temporary changelog is present on startup you are prompted to remove or keep it.
 
+
 **Ease of navigation**
 
 You can access files/folders and configuration straight from the menus, so you shouldn't find yourself searching through the program's directory or even your local user data very often.
 
+
 **Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/README.md

@@ -3,9 +3,11 @@
 
 > **A lightweight TUI app for managing and simplifying your Markdown changelogs.**
 
-* **Setup:** Start with [SETUP](./SETUP.md) to get started.
+> `pip install developer-assistant`
 
-* **Changes:** Yes, I keep a [CHANGELOG](./CHANGELOG.md)
+* **Installation:** detailed instructions in [SETUP](./SETUP.md)
+
+* **Changes:** yes, I keep a [CHANGELOG](./CHANGELOG.md)
 
 ---
 
@@ -19,6 +21,8 @@
 ## Appearance
 
 ### Coloured, easy-to-use menus
+A comfortable interface with a modern polish, built the good old way:
+
 ![Changelog Menu](documents/images/changelog-menu.png)
 
 ### Beautiful changelog previews
@@ -30,9 +34,9 @@ Preview your Markdown changelogs directly in the terminal with Rich rendering:
 ## Introduction
 
 ### What does this tool do?
-Developer Assistant is a lightweight TUI for simplifying and managing your changelogs. You can customize the templates for each profile to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
+Developer Assistant is a lightweight TUI for simplifying and managing your changelogs. You can customize the templates for **each profile** to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
 
-You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are and what's the last version number.
+You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are, which profile owns them and what's the last version number.
 
 Your files are kept safe at all times. Before adding new changes, your existing `CHANGELOG.md` is automatically backed up. While editing, all changes are written to a temporary file first and only prepended to & replaced with your real changelog once you confirm them.
 
@@ -55,22 +59,43 @@ Don't change the folder structure or modify variable names inside `.ini` files.
 
 The `da-ui/` folder and subfolders will be created automatically.
 
-You can access its content quickly when going to: `Main menu / Settings`
+> [!TIP] 
+> You can access its content quickly when going to: `Main menu / Settings`
 
 **Profiles for seperate projects and templates**
 
 The program comes with the "Default" profile, you can choose to either stick with this one or create your own profiles in `Main menu / Profiles`. Each profile has seperate projects and they can't be accessed by other profiles. You can choose to customize the templates seperately too.
 
-Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
+> [!NOTE]
+> Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
+
+---
 
 **Customizable templates**
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
+Templates come in three flavours:
+
+* changelog_template.txt - *Changelog title*
+
+* header_template.txt - *Version and date*
+
+* entry_template.txt - *Change entry and comments*
+
+
 **Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
+[Project.ini example](./documents/project-example.ini)
+
+The `command` variable is a custom command that DA will run in your project folder once you choose "Format & commit" in `Main menu / Projects / Project menu / Changelog`. Even when provided, it is **not** run without your confirmation, first it's printed with the folder name and you can choose to skip it.
+
+`owner` & `edited` are filled out automatically when a new project is created and `edited` updates with every changelog update.
+
+---
+
 **Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
@@ -79,10 +104,12 @@ New changes are first written to a temporary file and only prepended to & replac
 This ensures your existing changelog is never overwritten or corrupted, and you always have a fallback copy.
 If the temporary changelog is present on startup you are prompted to remove or keep it.
 
+
 **Ease of navigation**
 
 You can access files/folders and configuration straight from the menus, so you shouldn't find yourself searching through the program's directory or even your local user data very often.
 
+
 **Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:
@@ -97,7 +124,8 @@ The `memory.ini` file does exactly what you'd expect, it features:
 
 Last project & active profile get updated automatically, the rest are up to you.
 
-**`Ctrl+C` works everywhere to quickly exit DA.**
+> [!TIP] 
+> **`Ctrl+C` works everywhere to quickly exit DA.**
 
 ---
 
@@ -113,10 +141,15 @@ Once configured, you can create as many changelog entries as you want by picking
 Two possibilities, depending on how you installed.
 
 ### 1. Installed from PyPI
-A. **Using uv:** `uv tool upgrade developer-assistant`
-
-B. **Using pip:** `python -m pip install -U developer-assistant`
-
+A. **Using uv:** 
+```bash
+uv tool upgrade developer-assistant
+```
+
+B. **Using pip:** 
+```bash
+python -m pip install -U developer-assistant
+```
 
 ### 2. Installed from a local clone
 *Run all terminal commands in the repo folder*

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/default/test-project.ini

@@ -3,5 +3,7 @@ edited =
 owner = Default
 path = C:\Users\...\Developer-Assistant\test-project
 changelog = C:\Users\...\Developer-Assistant\test-project\CHANGELOG.md
-version = 1.0.0
+version = 1.0.0
+command = git add CHANGELOG.md
+;; the command could be anything, DA will run it in your project folder if you add it (runs in "Format & commit")
 cloud = 

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/interface.py

@@ -17,7 +17,7 @@ from importlib import resources
 
 class Interface:
     def __init__(self):
-        self.version = "0.3.0"
+        self.version = "0.3.5"
         self.clear = 'cls' if platform.system() == 'Windows' else 'clear'
 
         title = f"DA - {self.version}"
@@ -104,7 +104,7 @@ class Interface:
         while True:
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Exit\n")
             print("Last project:")
             print(colored(last_project, f"{self.color}"))
@@ -116,7 +116,7 @@ class Interface:
 
             if choice.lower() == "e":
                 os.system(self.clear)
-                print(self.header.center(127, "="))
+                print(self.header)
                 print("Bye!")
                 time.sleep(1)
                 return "exit"
@@ -131,14 +131,14 @@ class Interface:
                 return "settings"
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
     
     def settings(self):
         while True:
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Settings")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
 
             print(colored("Configuration options", attrs=["underline"]))
@@ -166,14 +166,14 @@ class Interface:
                 Opener.open(self.config.templates_folder)
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
 
     def profiles(self):
         while True:
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Profiles")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
 
             print("1. Create a new profile")
@@ -189,7 +189,7 @@ class Interface:
                 self.switch_profile()
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
 
     def switch_profile(self):
@@ -256,9 +256,17 @@ class Interface:
         self.memory = self.config.load_memory()
 
         self.color = self.memory.get('color') or "light_blue"
-        self.header = (colored(" Developer Assistant ", f"{self.color}"))
         self.user_path = os.environ.get('USERPROFILE') or os.environ.get('HOME', 'User')
 
+        brand = (colored(" Developer Assistant ", f"{self.color}"))
+        text = " Developer Assistant "
+
+        columns, _ = shutil.get_terminal_size()
+        pad_size = (columns - len(text)) // 2
+        bars = "=" * max(0, pad_size)
+
+        self.header = f"{bars}{brand}{bars}"
+
     def local_init(self):
         default_files = resources.files("da.default")
         dest = self.config.memory_ini
@@ -268,7 +276,7 @@ class Interface:
                 shutil.copy(item, dest)
 
         self.config.projects_folder.mkdir(parents=True, exist_ok=True)
-        # Add Test-Project
+
         dest = self.config.projects_folder
         for item in default_files.iterdir():
             if item.name == "test-project.ini":
@@ -283,9 +291,8 @@ class Interface:
 
         readme_content = resources.files("da").joinpath("intro.md").read_text()
 
-        MARKDOWN = readme_content
         console = Console()
-        md = Markdown(MARKDOWN)
+        md = Markdown(readme_content)
         console.print(md)
 
         input("\nContinue..." + colored("[Enter]", f"{self.color}"))

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/intro.md

@@ -31,13 +31,15 @@ Don't change the folder structure or modify variable names inside `.ini` files.
 
 The `da-ui/` folder and subfolders will be created automatically.
 
-You can access its content quickly when going to: `Main menu / Settings`
+> Tip:
+> You can access its content quickly when going to: `Main menu / Settings`
 
 **Profiles for seperate projects and templates**
 
 The program comes with the "Default" profile, you can choose to either stick with this one or create your own profiles in `Main menu / Profiles`. Each profile has seperate projects and they can't be accessed by other profiles. You can choose to customize the templates seperately too.
 
-Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
+> Note:
+> Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
 
 ---
 
@@ -45,10 +47,25 @@ Migrating a project or template from one profile to another is currently manual,
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
+Templates come in three flavours:
+
+* changelog_template.txt - *Changelog title*
+
+* header_template.txt - *Version and date*
+
+* entry_template.txt - *Change entry and comments*
+
+
 **Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
+The `command` variable is a custom command that DA will run in your project folder once you choose "Format & commit" in `Main menu / Projects / Project menu / Changelog`. Even when provided, it is **not** run without your confirmation, first it's printed with the folder name and you can choose to skip it.
+
+`owner` & `edited` are filled out automatically when a new project is created and `edited` updates with every changelog update.
+
+---
+
 **Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
@@ -57,10 +74,12 @@ New changes are first written to a temporary file and only prepended to & replac
 This ensures your existing changelog is never overwritten or corrupted, and you always have a fallback copy.
 If the temporary changelog is present on startup you are prompted to remove or keep it.
 
+
 **Ease of navigation**
 
 You can access files/folders and configuration straight from the menus, so you shouldn't find yourself searching through the program's directory or even your local user data very often.
 
+
 **Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:
@@ -75,4 +94,4 @@ The `memory.ini` file does exactly what you'd expect, it features:
 
 Last project & active profile get updated automatically, the rest are up to you.
 
-**`Ctrl+C` works everywhere to quickly exit DA.**
+> **`Ctrl+C` works everywhere to quickly exit DA.**

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/modules/config_manager.py

@@ -65,7 +65,6 @@ class ConfigManager:
         return
         
     def project_ini(self):
-        #==Create new project ini==
         project_parser = configparser.ConfigParser()
         project_parser["SETTINGS"] = self.data
         
@@ -77,7 +76,6 @@ class ConfigManager:
         return
     
     def load_project(self):
-        #==Return project ini variables==
         project_parser = configparser.ConfigParser()
         project_parser.read(self.new_project_ini)
 
@@ -88,6 +86,7 @@ class ConfigManager:
             'path': prj.get('path'),
             'changelog': prj.get('changelog'),
             'version': prj.get('version'),
+            'command': prj.get('command'),
             'cloud': prj.get('cloud')
         }
 

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/modules/opener.py

@@ -7,12 +7,10 @@ from termcolor import colored
 class Opener:
     @staticmethod
     def open(path):
-        #==Check if path exists==
         if not os.path.exists(path):
             print(colored("\nThis path does not exist.", "light_red"))
             time.sleep(1)
             return
-        #==Open if exists==
         else:
             system = platform.system()
             if system == "Windows":

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/modules/projects_manager.py

@@ -5,6 +5,7 @@ import platform
 from pathlib import Path
 from datetime import datetime
 
+from prompt_toolkit import prompt
 from termcolor import colored
 
 from da.modules.config_manager import ConfigManager
@@ -25,7 +26,7 @@ class ProjectsManager:
             self.memory = self.config.load_memory()
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Projects")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
             print(colored("1. Last project:", attrs=["underline"]))
             print(colored(self.memory.get('last_project'), f"{self.color}"))
@@ -48,7 +49,7 @@ class ProjectsManager:
             elif choice == "1":
                 project = self.memory.get('last_project')
                 if not project:
-                    print(colored("\nLast project has not been defined...", "light_red", attrs=["blink"]))
+                    print(colored("\nLast project has not been defined...", "light_red", attrs=["bold"]))
                     time.sleep(1)
                 else:
                     self.load_project(f"{project}")
@@ -57,7 +58,6 @@ class ProjectsManager:
                 self.new_project()
 
             elif choice.lower() in ("a", "b", "c"):
-                #==If the pinned project is empty, return an error message==
                 options_map = {
                     'a': 'pinned_project',
                     'b': 'pinned_project1',
@@ -67,7 +67,7 @@ class ProjectsManager:
                 project_name = self.memory.get(key)
                 if project_name == "":
                     print("")
-                    print(colored(f"Project '{choice}' has not been defined...", "light_red", attrs=["blink"]))
+                    print(colored(f"Project '{choice}' has not been defined...", "light_red", attrs=["bold"]))
                     time.sleep(1)
                 else:
                     project = self.memory.get(key)
@@ -77,7 +77,7 @@ class ProjectsManager:
                 self.prf_projects()
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
 
     def new_project(self):
@@ -86,21 +86,23 @@ class ProjectsManager:
         now = datetime.now()
         today = now.strftime("%Y-%m-%d")
 
-        print(self.header.center(127, "="))
+        print(self.header)
         print("E. Abort/back\n")
         
-        name = input("Enter new project name > ")
+        name = prompt("Enter new project name > ")
         if name.lower() == "e":
             return
-        path = input("\nEnter project path > ")
+        path = prompt("\nEnter project path > ")
 
-        changelog = input("\nProject changelog path > ")
+        changelog = prompt("\nProject changelog path > ")
 
-        version = input("\nCurrent project version > ")
+        version = prompt("\nCurrent project version > ")
 
-        #cloud = input("\nCloud service (not required) > ")
+        command = prompt("\nCustom commit command > ")
 
-        confirm = input("\nConfirm(Y) or abort(E) > ")
+        #cloud = prompt("\nCloud service (not required) > ")
+
+        confirm = input("\nConfirm(Y) or abort(E) > ").strip()
         if confirm.lower() == "e":
             return
             
@@ -112,6 +114,7 @@ class ProjectsManager:
                 "path": path,
                 "changelog": changelog,
                 "version": version,
+                "command": command,
                 "cloud": ""
             }
             new_manager.project_ini()
@@ -119,15 +122,15 @@ class ProjectsManager:
             
         else:
             print("")
-            print(colored("Unknown option, try again...", "light_red", attrs=["blink"]))
-            time.sleep(2)
+            print(colored("Unknown option, try again...", "light_red", attrs=["bold"]))
+            time.sleep(1)
             return
 
     def prf_projects(self):
         while True:
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Projects / Profile projects")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
             prof_prj = self.config.projects_folder
             contents = os.listdir(prof_prj)
@@ -150,7 +153,7 @@ class ProjectsManager:
                 self.load_project(project)
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
             
     def load_project(self, project):
@@ -190,7 +193,7 @@ class ProjectsManager:
 
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Projects / Project menu")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
             print(colored("Chosen project:", attrs=["underline"]))
             print(colored(project, f"{self.color}"))
@@ -208,8 +211,7 @@ class ProjectsManager:
                 return
 
             elif choice == "1":
-                path = setting.get('path')
-                folder = Path(path)
+                folder = Path(setting.get('path'))
                 Opener.open(folder)
 
             elif choice == "2":
@@ -223,27 +225,28 @@ class ProjectsManager:
                 if os.path.exists(changelog):
                     print(colored("\nThis action will overwrite your existing changelog!\n", "yellow"))
                     input("Acknowledge..." + colored("[Enter]", f"{self.color}"))
-                self.rest_bak(setting, project)
+
+                self.rest_bak(setting, changelog, project)
 
             #elif choice == "5":
 
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
 
-    def rest_bak(self, setting, project):
+    def rest_bak(self, setting, changelog, project):
         prj_path = Path(setting.get('path'))
         has_bak = list(prj_path.glob("*.bak"))
 
         if not has_bak:
             print(colored(f"\nCan't find any .bak files for {project}", "yellow"))
-            time.sleep(2)
+            time.sleep(1)
             return
 
         bak = has_bak[0]
-        bak.rename(prj_path / "CHANGELOG.md")
-        print(f"\nRenamed {bak.name} to CHANGELOG.md")
+        os.replace(bak, changelog)
+        print(f"\nReplaced {bak.name} with CHANGELOG.md")
         time.sleep(1)
         return
 

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/da/modules/version_logic.py

@@ -24,6 +24,7 @@ class VersionLogic:
         self.user_path = user_path
 
         self.memory = self.config.load_memory()
+        self.console = Console()
     
     def project_menu(self, project, profile):
         self.active_project = project
@@ -43,16 +44,16 @@ class VersionLogic:
             self.setting = load_manager.load_project()
             self.changelog_path = Path(self.setting.get('changelog'))
             self.prj_ver = self.setting.get('version')
-            prj_path = Path(self.setting.get('path'))
+            self.prj_path = Path(self.setting.get('path'))
 
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Projects / Project menu / Changelog")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back\n")
             print(colored("Chosen project:", attrs=["underline"]))
             print(colored(self.active_project, f"{self.color}"))
             print("Version: " + colored(self.prj_ver, f"{self.color}"))
-            print("\n1. Create a new changelog")
+            print("\n1. Format & commit")
             print("2. Add new changes")
             print("\n3. Open the changelog")
             print("4. Preview .md changelog\n")
@@ -63,26 +64,27 @@ class VersionLogic:
                 return
 
             elif choice == "1":
-                if not os.path.exists(prj_path):
-                    print(colored("\nSystem cannot find the path to this project.", "light_red"))
-                    time.sleep(1.5)
+                if not os.path.exists(self.changelog_path):
+                    print(no_path)
+                    time.sleep(1)
                 else:
-                    self.create_changelog()
+                    self.finalise()
 
             elif choice == "2":
-                if not os.path.exists(self.changelog_path):
-                    print(no_path)
-                    time.sleep(1.5)
+                if not os.path.exists(self.prj_path):
+                    print(colored("\nSystem cannot find the path to this project.", "light_red"))
+                    time.sleep(1)
                 else:
                     self.update_changelog()
 
             elif choice == "3":
                 if not os.path.exists(self.changelog_path):
                     print(no_path)
-                    time.sleep(1.5)
+                    time.sleep(1)
                     continue
                 else:
-                    if self.check_size():
+                    method = self.check_size()
+                    if method == "reject":
                         continue
                     else:
                         Opener.open(self.changelog_path)
@@ -90,55 +92,56 @@ class VersionLogic:
             elif choice == "4":
                 if not os.path.exists(self.changelog_path):
                     print(no_path)
-                    time.sleep(1.5)
+                    time.sleep(1)
                 else:
-                    self.view_md(self.changelog_path)
+                    log_content = ""
+                    with open(self.changelog_path, "r", encoding="utf-8") as f:
+                        log_content = f.read()
+                    self.view_md(log_content)
 
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
             
-    def create_changelog(self):
-        os.system(self.clear)
-        print(self.header.center(127, "="))
-        print("E. Back/abort\n")
-
-        if os.path.exists(self.changelog_path):
-            print(colored("This action will overwrite your existing changelog!\n", "yellow"))
-            input("Acknowledge..." + colored("[Enter]\n", f"{self.color}"))
+    def finalise(self):
+        with open(self.changelog_path, "r", encoding="utf-8") as f:
+            existing = f.read()
 
-        version = input("Version > ")
-        if version.lower() == "e":
-            return
-        change_type = input("\nChange type > ")
+        template = self.template_loader("changelog_template.txt")
 
-        entry = prompt("\nFirst entry > ")
+        combined = template + "\n" + existing
 
-        comment = prompt("\nOptional comment > ")
+        prj_dir = self.changelog_path.parent
+        fd, temp_path = tempfile.mkstemp(dir=prj_dir, text=True)
 
-        choice = input("\nSave (Enter) Cancel (E).\nAdd further entries with 'Add new changes' in the menu! > ")
-        if choice.lower() == "e":
-            return
+        try:
+            with os.fdopen(fd, "w", encoding="utf-8") as f:
+                f.write(combined)
+                f.flush()
 
-        data = {
-            "date": self.today,
-            "version": version,
-            "type": change_type,
-            "changes": entry,
-            "comments": comment
-        }
+            os.replace(temp_path, self.changelog_path)
 
-        template = self.template_loader("changelog_template.txt")
+        except Exception as e:
+            if os.path.exists(temp_path):
+                os.remove(temp_path)
+            raise e
 
-        rendered = self.template_renderer(template, data)
+        cmd = self.setting.get('command')
 
-        with open(self.changelog_path, "w", encoding="utf-8") as f:
-            f.write(rendered + "\n")
+        if cmd.strip():
+            print("\nwill run: " + colored(f"{cmd}", f"{self.color}"))
+            print("in folder: " + colored(f"{self.prj_path}", f"{self.color}"))
+            confirm = input("\nConfirm[Enter] or abort[E] > ").strip()
+            print("")
 
-        new_config = ConfigManager(f"{self.active_project}.ini", profile=self.active_profile)
-        new_config.update_project("version", version)
-        new_config.update_project("edited", self.today)
+            if confirm.lower() == "e":
+                return
+            try:
+                subprocess.run(cmd, cwd=self.prj_path, shell=True, check=True)
+            except Exception as e:
+                print(colored("\nfailed: ", "light_red") + f"{e}")
+                input("\nReturn...[Enter]")
 
         last_project = self.memory.get('last_project')
         if last_project != self.active_project:
@@ -147,8 +150,10 @@ class VersionLogic:
         return
 
     def update_changelog(self):
-        if self.check_size():
-            return
+        if os.path.exists(self.changelog_path):
+            method = self.check_size()
+            if method == "reject":
+                return
 
         self.change_type = None
         self.change = None
@@ -156,7 +161,7 @@ class VersionLogic:
         while True:
             os.system(self.clear)
             print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu / Projects / Project menu / Changelog / Add changes")
-            print(self.header.center(127, "="))
+            print(self.header)
             print("E. Back/abort")
             print("O. Open templog for fixes")
             print("S. Review changes & save\n")
@@ -183,7 +188,6 @@ class VersionLogic:
 
             type_choice = input(f"{self.user_path}> ").strip()
 
-            #==Assign change types to keys==
             type_map = {
                 "1": "Added",
                 "2": "Removed",
@@ -207,7 +211,7 @@ class VersionLogic:
                 self.save_changes()
             else:
                 print("")
-                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                print(colored("Unknown option...", "light_red", attrs=["bold"]))
                 time.sleep(1)
 
     def prepend_changes(self):
@@ -218,21 +222,20 @@ class VersionLogic:
             with open(self.templog_path, "r", encoding="utf-8") as f:
                 existing = f.read()
 
-        #==Add the change type header if needed==
         if header not in existing:
             with open(self.templog_path, "a", encoding="utf-8") as f:
                 f.write(header + "\n")
 
         while True:
             os.system(self.clear)
-            print(self.header.center(127, "="))
+            print(self.header)
 
             print("Chosen change type:")
             print(colored(self.change_type, f"{self.color}"))
 
-            self.change = prompt("\nChange entry: ")
+            self.change = prompt("\nChange entry > ")
 
-            self.comment = prompt("\nOptional comment: ")
+            self.comment = prompt("\nOptional comment > ")
 
             data = {
                 "changes": self.change,
@@ -246,13 +249,13 @@ class VersionLogic:
             with open(self.templog_path, "a", encoding="utf-8") as f:
                 f.write(rendered + "\n")
 
-            choice = input("\nSave & exit [E] or add more [Enter]? ")
+            choice = input("\nNew type [E] or add more [Enter] > ")
             if choice.lower() == "e":
                 return
 
     def save_changes(self):
         os.system(self.clear)
-        print(self.header.center(127, "="))
+        print(self.header)
         print(colored("Please check the output file:", f"{self.color}", attrs=["underline"]))
 
         templog_content = ""
@@ -260,18 +263,15 @@ class VersionLogic:
             with open(self.templog_path, "r", encoding="utf-8") as f:
                 templog_content = f.read()
 
-            print(colored(f"[New version] - {self.today}\n", "magenta", attrs=["underline"]))
+            message = colored(f"[New version] - {self.today}\n", "magenta", attrs=["underline"])
 
-            MARKDOWN = templog_content
-            console = Console()
-            md = Markdown(MARKDOWN)
-            console.print(md)
+            self.view_md(templog_content, message)
         else:
             print(colored("No changes added.", "light_red"))
             time.sleep(1)
             return
 
-        choice = input("\nContinue" + colored("[Enter]", f"{self.color}") + " or go back" + colored("[E] ", f"{self.color}"))
+        choice = input("\nContinue" + colored("[Enter]", f"{self.color}") + " or add more" + colored("[E] ", f"{self.color}"))
 
         if choice.lower() == "e":
             return
@@ -291,10 +291,8 @@ class VersionLogic:
 
         old_content = ""
         if os.path.exists(self.changelog_path):
-            #==Make a duplicate of the old changelog==
-            log_name = f"Changelog-{self.today}.bak"
-            project_folder = Path(self.setting.get('path'))
-            duplicate_path = project_folder / log_name
+            log_name = "changelog.bak"
+            duplicate_path = self.prj_path / log_name
 
             src = self.changelog_path
             dest = duplicate_path
@@ -336,35 +334,47 @@ class VersionLogic:
         time.sleep(2)
         return
 
-    def view_md(self, log_path):
-        if self.check_size():
-            return
-
-        os.system(self.clear)
-        print(self.header.center(127, "="))
-        print("")
+    def view_md(self, log_content, message=None):
+        flag = 0
+        if not message:
+            method = self.check_size()
+            if method == "reject":
+                return
+            elif method == "print":
+                flag = 1
 
-        log_content = ""
-        with open(log_path, "r", encoding="utf-8") as f:
-            log_content = f.read()
+        if message:
+            print(message)
+        else:
+            os.system(self.clear)
+            print(self.header)
+            print("")
 
-        MARKDOWN = log_content
-        console = Console()
-        md = Markdown(MARKDOWN)
-        console.print(md)
+        if flag:
+            print(log_content)
+            print(colored("\nThis log is too large to render in Markdown! (Max 10MB)", "yellow"))
+        else:
+            md = Markdown(log_content)
+            self.console.print(md)
 
-        input("\nReturn..." + colored("[Enter]", f"{self.color}"))
+        if not message:
+            input("\nReturn..." + colored("[Enter]", f"{self.color}"))
         return
 
     def check_size(self):
-        MAX_SIZE = 100 * 1024 * 1024
+        print_size = 10 * 1024 * 1024
+        max_size = 20 * 1024 * 1024
 
         size = self.changelog_path.stat().st_size
         size_mb = size / (1024 * 1024)
-        if size > MAX_SIZE:
+
+        if size > max_size:
             print(colored(f"\nChangelog too large to load safely: {size_mb:.2f} MB", "light_red"))
             time.sleep(2)
-            return True
+            return "reject"
+
+        elif size > print_size:
+            return "print"
 
     def template_loader(self, template_file):
         template_path = self.config.templates_folder / template_file

developer_assistant-0.3.5/da/templates/changelog_template.txt

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)

{developer_assistant-0.3.0 → developer_assistant-0.3.5/developer_assistant.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: developer-assistant
-Version: 0.3.0
+Version: 0.3.5
 Summary: A lightweight TUI app for managing and simplifying your Markdown changelogs.
 License: The MIT License (MIT)
         
@@ -12,11 +12,8 @@ License: The MIT License (MIT)
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 Project-URL: Homepage, https://github.com/Ivory-Hubert/Developer-Assistant
-Project-URL: Repository, https://github.com/Ivory-Hubert/Developer-Assistant.git
-Project-URL: Issues, https://github.com/Ivory-Hubert/Developer-Assistant/issues
 Project-URL: Changelog, https://github.com/Ivory-Hubert/Developer-Assistant/blob/main/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -32,6 +29,9 @@ Dynamic: license-file
 # Developer Assistant
 
 ## Installing from PyPI
+
+The program is designed for minimal friction and simple setup. Only installation is required, on first run DA will create local user data automatically. The same process is used for new profiles.
+
 **Using uv:**
 `uv tool install developer-assistant`
 
@@ -53,17 +53,18 @@ A. **Using uv:** `uv tool upgrade developer-assistant`
 
 B. **Using pip:** `python -m pip install -U developer-assistant`
 
+
 ## Introduction
 
 ### What does this tool do?
-Developer Assistant is a lightweight TUI app for simplifying and managing your changelogs. You can customize the templates for each profile to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
+Developer Assistant is a lightweight TUI for simplifying and managing your changelogs. You can customize the templates for **each profile** to match your existing format, and use DA as a central hub to access every changelog and project folder you maintain.
 
-You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are and what's the last version number.
+You can create as many profiles as you need. Each profile gets its own **project specific** `.ini` files, created automatically through the menu based on the information you provide. These act as links that tell DA where your changelogs are, which profile owns them and what's the last version number.
 
 Your files are kept safe at all times. Before adding new changes, your existing `CHANGELOG.md` is automatically backed up. While editing, all changes are written to a temporary file first and only prepended to & replaced with your real changelog once you confirm them.
 
 
-## Using the program.
+### Using the program.
 1. **What *not* to do**
 
 Don't change the folder structure or modify variable names inside `.ini` files.
@@ -88,14 +89,33 @@ The program comes with the "Default" profile, you can choose to either stick wit
 
 Migrating a project or template from one profile to another is currently manual, **make sure to also change the "*owner*" value in `.ini` files accordingly**.
 
+---
+
 **Customizable templates**
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
+Templates come in three flavours:
+
+* changelog_template.txt - *Changelog title*
+
+* header_template.txt - *Version and date*
+
+* entry_template.txt - *Change entry and comments*
+
+
 **Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
+[Project.ini example](./documents/project-example.ini)
+
+The `command` variable is a custom command that DA will run in your project folder once you choose "Format & commit" in `Main menu / Projects / Project menu / Changelog`. Even when provided, it is **not** run without your confirmation, first it's printed with the folder name and you can choose to skip it.
+
+`owner` & `edited` are filled out automatically when a new project is created and `edited` updates with every changelog update.
+
+---
+
 **Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
@@ -104,10 +124,12 @@ New changes are first written to a temporary file and only prepended to & replac
 This ensures your existing changelog is never overwritten or corrupted, and you always have a fallback copy.
 If the temporary changelog is present on startup you are prompted to remove or keep it.
 
+
 **Ease of navigation**
 
 You can access files/folders and configuration straight from the menus, so you shouldn't find yourself searching through the program's directory or even your local user data very often.
 
+
 **Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:

{developer_assistant-0.3.0 → developer_assistant-0.3.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "developer-assistant"
-version = "0.3.0"
+version = "0.3.5"
 description = "A lightweight TUI app for managing and simplifying your Markdown changelogs."
 readme = "PYPI.md"
 requires-python = ">=3.10"
@@ -13,7 +13,6 @@ dependencies = [
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Environment :: Console",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -21,8 +20,6 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/Ivory-Hubert/Developer-Assistant"
-Repository = "https://github.com/Ivory-Hubert/Developer-Assistant.git"
-Issues = "https://github.com/Ivory-Hubert/Developer-Assistant/issues"
 Changelog = "https://github.com/Ivory-Hubert/Developer-Assistant/blob/main/CHANGELOG.md"
 
 [project.scripts]

developer_assistant-0.3.0/da/templates/changelog_template.txt

@@ -1,6 +0,0 @@
-## [{{version}}] - {{date}}
-
-### {{type}}
-- **{{changes}}**
-
-{{comments}}