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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: developer-assistant
-Version: 0.2.1
-Summary: A lightweight TUI designed to simplify formatting of Markdown changelogs.
+Version: 0.3.0
+Summary: A lightweight TUI app for managing and simplifying your Markdown changelogs.
 License: The MIT License (MIT)
         
         Copyright (c) 2026 Ivori Huobolainen
@@ -42,6 +42,10 @@ Dynamic: license-file
 
 > **Tip:** Once setup is complete and you start the program, an intro with all the necessary information will be displayed for you in the terminal.
 
+> **Linux note:**
+> Avoid using `sudo pip install` because it installs into the system Python.
+If you want a system‑wide install, use the uv method or use `pip install --user`
+
 ## Updating DA
 Two possibilities, depending on how you installed.
 
@@ -52,14 +56,14 @@ B. **Using pip:** `python -m pip install -U developer-assistant`
 ## Introduction
 
 ### What does this tool do?
-Developer Assistant is a lightweight TUI tool for automating and managing your changelogs. You can customize the templates 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 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.
 
-You can manage as many projects as you like. Each project gets its own `.ini` file, 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 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 applied to the real changelog once you confirm them.
+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.
@@ -68,52 +72,62 @@ Don't change the folder structure or modify variable names inside `.ini` files.
 
 **The user's data (`Templates/`, `Projects/`, `memory.ini`) is stored in standard locations:**
 
-Windows: `C:\Users\...\AppData\Roaming\da-ui\`
+* Windows: `C:\Users\...\AppData\Roaming\da-ui\`
 
-Linux: `~/.config/da-ui/`
+* Linux: `~/.config/da-ui/`
 
-macOS: `~/Library/Application Support/da-ui/`
+* macOS: `~/Library/Application Support/da-ui/`
 
-The `da-ui/` folder will be created automatically.
+The `da-ui/` folder and subfolders will be created automatically.
 
 You can access its content quickly when going to: `Main menu / Settings`
 
-- *Customizable templates*
+**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**.
+
+**Customizable templates**
 
 In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
 
-- *Linked projects all in one place*
+**Linked projects all in one place**
 
 The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
 
-- *Safe changelog updates*
+**Safe changelog updates**
 
 Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
-New changes are first written to a temporary file and only applied to the real changelog after you confirm them.
+New changes are first written to a temporary file and only prepended to & replaced with your real changelog once you confirm them.
+
 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*
+**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*
+**Configuration**
 
 The `memory.ini` file does exactly what you'd expect, it features:
 
-> Last project
+* Last project
+
+* Pinned projects
+
+* Active profile
 
-> Pinned projects
+* Custom colour
 
-> Custom colour
+Last project & active profile get updated automatically, the rest are up to you.
 
-Last project gets updated automatically, the rest are up to you.
+**`Ctrl+C` works everywhere to quickly exit DA.**
 
-- *`Ctrl+C` works everywhere to quickly exit DA.*
 
-### Setting up your first project
-For a dummy changelog to experiment with, navigate to `Main menu / Projects`, choose `Test-Project`, then choose option `4.` to start adjusting this projects paths. 
+### Setting up the test project
+For a dummy changelog to experiment with, navigate to `Main menu / Projects`, choose `test-project`, then choose option `3.` to start adjusting this projects paths. **Before setting up your own profile don't change "*Default*"**
 
-Now make an optional `Test-Project/` folder with a `CHANGELOG.md` in it anywhere on your system and point the `.ini` file to it.
+The `test-project/` folder is included in the programs root folder **for repo clones** and is safe to experiment with. If you installed from PyPI just make a `CHANGELOG.md` anywhere and point the `.ini` file to it.
 
 Once configured, you can create as many changelog entries as you want by picking that project in the menu.

developer_assistant-0.3.0/PYPI.md

@@ -0,0 +1,102 @@
+# Developer Assistant
+
+## Installing from PyPI
+**Using uv:**
+`uv tool install developer-assistant`
+
+**Using pip:**
+`pip install developer-assistant`
+
+**Then use `da-ui` anywhere in your terminal to run it**
+
+> **Tip:** Once setup is complete and you start the program, an intro with all the necessary information will be displayed for you in the terminal.
+
+> **Linux note:**
+> Avoid using `sudo pip install` because it installs into the system Python.
+If you want a system‑wide install, use the uv method or use `pip install --user`
+
+## Updating DA
+Two possibilities, depending on how you installed.
+
+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.
+
+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.
+
+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.
+1. **What *not* to do**
+
+Don't change the folder structure or modify variable names inside `.ini` files.
+
+2. **Features and information**
+
+**The user's data (`Templates/`, `Projects/`, `memory.ini`) is stored in standard locations:**
+
+* Windows: `C:\Users\...\AppData\Roaming\da-ui\`
+
+* Linux: `~/.config/da-ui/`
+
+* macOS: `~/Library/Application Support/da-ui/`
+
+The `da-ui/` folder and subfolders will be created automatically.
+
+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**.
+
+**Customizable templates**
+
+In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
+
+**Linked projects all in one place**
+
+The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
+
+**Safe changelog updates**
+
+Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
+New changes are first written to a temporary file and only prepended to & replaced with your real changelog once you confirm them.
+
+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:
+
+* Last project
+
+* Pinned projects
+
+* Active profile
+
+* Custom colour
+
+Last project & active profile get updated automatically, the rest are up to you.
+
+**`Ctrl+C` works everywhere to quickly exit DA.**
+
+
+### Setting up the test project
+For a dummy changelog to experiment with, navigate to `Main menu / Projects`, choose `test-project`, then choose option `3.` to start adjusting this projects paths. **Before setting up your own profile don't change "*Default*"**
+
+The `test-project/` folder is included in the programs root folder **for repo clones** and is safe to experiment with. If you installed from PyPI just make a `CHANGELOG.md` anywhere and point the `.ini` file to it.
+
+Once configured, you can create as many changelog entries as you want by picking that project in the menu.

developer_assistant-0.3.0/README.md

@@ -0,0 +1,136 @@
+# Developer Assistant
+[![PyPI version](https://img.shields.io/pypi/v/developer-assistant?logo=pypi&logoColor=white&color=blue)](https://pypi.org/project/developer-assistant/)
+
+> **A lightweight TUI app for managing and simplifying your Markdown changelogs.**
+
+* **Setup:** Start with [SETUP](./SETUP.md) to get started.
+
+* **Changes:** Yes, I keep a [CHANGELOG](./CHANGELOG.md)
+
+---
+
+* **Requirements:** Python 3.10 or later.
+
+* **Cross-platform:** Windows, Linux, macOS(*unverified*)
+
+* **Specifics:** [SYSTEM STRUCTURE](./documents/SYSTEM_STRUCTURE.txt)
+
+
+## Appearance
+
+### Coloured, easy-to-use menus
+![Changelog Menu](documents/images/changelog-menu.png)
+
+### Beautiful changelog previews
+Preview your Markdown changelogs directly in the terminal with Rich rendering:
+
+![Changelog Preview](documents/images/md-preview.png)
+
+
+## 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.
+
+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.
+
+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.
+1. **What *not* to do**
+
+Don't change the folder structure or modify variable names inside `.ini` files.
+
+2. **Features and information**
+
+**The user's data (`Templates/`, `Projects/`, `memory.ini`) is stored in standard locations:**
+
+* Windows: `C:\Users\...\AppData\Roaming\da-ui\`
+
+* Linux: `~/.config/da-ui/`
+
+* macOS: `~/Library/Application Support/da-ui/`
+
+The `da-ui/` folder and subfolders will be created automatically.
+
+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**.
+
+**Customizable templates**
+
+In the **local** `Templates/` folder you can modify the template contents to your liking - **just avoid changing the `{{placeholder}}` names**.
+
+**Linked projects all in one place**
+
+The `Projects/` folder holds the `.ini` files you create when starting a new project with DA. 
+
+**Safe changelog updates**
+
+Before applying any changes, your previous `CHANGELOG.md` is automatically backed up into your project folder. 
+New changes are first written to a temporary file and only prepended to & replaced with your real changelog once you confirm them.
+
+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:
+
+* Last project
+
+* Pinned projects
+
+* Active profile
+
+* Custom colour
+
+Last project & active profile get updated automatically, the rest are up to you.
+
+**`Ctrl+C` works everywhere to quickly exit DA.**
+
+---
+
+### Setting up the test project
+For a dummy changelog to experiment with, navigate to `Main menu / Projects`, choose `test-project`, then choose option `3.` to start adjusting this projects paths. **Before setting up your own profile don't change "*Default*"**
+
+The `test-project/` folder is included in the programs root folder **for repo clones** and is safe to experiment with. If you installed from PyPI just make a `CHANGELOG.md` anywhere and point the `.ini` file to it.
+
+Once configured, you can create as many changelog entries as you want by picking that project in the menu.
+
+
+## Updating DA
+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`
+
+
+### 2. Installed from a local clone
+*Run all terminal commands in the repo folder*
+
+A. **Using uv:**
+
+1. `git pull`
+2. `uv tool install .`
+
+B. **Using pip:**
+
+1. `git pull`
+2. `pip install .`
+
+C. **No install, running from repo root:**
+
+Just `git pull`

{developer_assistant-0.2.1 → developer_assistant-0.3.0}/da/default/default-memory.ini

@@ -1,9 +1,10 @@
 [ITEMS]
 last_project = 
-pinned_project = Test-Project
+pinned_project = test-project
 pinned_project1 = 
 pinned_project2 = 
 
 [CONFIG]
+profile = Default
 color = 
 

developer_assistant-0.3.0/da/default/test-project.ini

@@ -0,0 +1,7 @@
+[SETTINGS]
+edited = 
+owner = Default
+path = C:\Users\...\Developer-Assistant\test-project
+changelog = C:\Users\...\Developer-Assistant\test-project\CHANGELOG.md
+version = 1.0.0
+cloud = 

developer_assistant-0.3.0/da/interface.py

@@ -0,0 +1,303 @@
+import os, sys
+import time
+import platform
+import subprocess
+import shutil
+from pathlib import Path
+
+from termcolor import colored
+from rich.progress import track
+from rich.console import Console
+from rich.markdown import Markdown
+
+from da.modules.projects_manager import ProjectsManager
+from da.modules.config_manager import ConfigManager
+from da.modules.opener import Opener
+from importlib import resources
+
+class Interface:
+    def __init__(self):
+        self.version = "0.3.0"
+        self.clear = 'cls' if platform.system() == 'Windows' else 'clear'
+
+        title = f"DA - {self.version}"
+
+        if platform.system() == "Windows":
+            os.system(f'title {title}')
+        else:
+            print(f'\33]0;{title}\a', end='', flush=True)
+
+        self.config = ConfigManager('memory.ini', profile="Default")
+
+        self.memory = None
+        self.color = None
+        self.header = None
+        self.user_path = None
+
+        self.first_run = False
+    
+    def run(self):
+        steps = [
+            ("Initializing runtime...", self.runtime_init),
+            ("Checking configuration...", self.config.data_check)
+        ]
+
+        for label, step in track(steps):
+            os.system(self.clear)
+            print(label.center(65))
+            result = step()
+            time.sleep(0.30)
+            if isinstance(result, list):
+                for msg in result:
+                    print(msg.center(65))
+                    time.sleep(2)
+
+        temp_log = Path(__file__).parent / "CHANGELOG.tmp"
+
+        if os.path.exists(temp_log):
+            while True:
+                os.system(self.clear)
+                print(colored(f"Temporary changelog detected in:\n{temp_log}\n", "yellow"))
+                print(colored("D", "light_red") + "elete or " + colored("K", "light_red") + "eep?\n")
+                choice = input(f"{self.user_path}> ").lower()
+                if choice == "d":
+                    os.remove(temp_log)
+                    break
+                elif choice == "k":
+                    break
+                else:
+                    print(colored("\nPlease make a valid choice.", "light_red"))
+                    time.sleep(1.5)
+        
+        state = "intro" if self.first_run else "menu"
+
+        while state != "exit":
+            if state == "intro":
+                self.intro()
+                state = "menu"
+
+            elif state == "menu":
+                result = self.menu()
+                if result == "profiles":
+                    self.profiles()
+                    state = "menu"
+
+                elif result == "settings":
+                    self.settings()
+                    state = "menu"
+
+                elif result == "exit":
+                    state = "exit"
+
+    def menu(self):
+        self.active_profile = self.memory.get('profile')
+
+        projects_manager = ProjectsManager(
+            config=self.config,
+            color=self.color,
+            header=self.header,
+            cls=self.clear,
+            user_path=self.user_path
+        )
+
+        last_project = self.memory.get('last_project')
+        while True:
+            os.system(self.clear)
+            print(colored(f"{self.active_profile}", f"{self.color}") + " / Main menu")
+            print(self.header.center(127, "="))
+            print("E. Exit\n")
+            print("Last project:")
+            print(colored(last_project, f"{self.color}"))
+            print("\n1. Projects")
+            print("2. Profiles")
+            print("3. Settings\n")
+
+            choice = input(f"{self.user_path}> ").strip()
+
+            if choice.lower() == "e":
+                os.system(self.clear)
+                print(self.header.center(127, "="))
+                print("Bye!")
+                time.sleep(1)
+                return "exit"
+
+            elif choice == "1":
+                projects_manager.projects(self.active_profile)
+
+            elif choice == "2":
+                return "profiles"
+
+            elif choice == "3":
+                return "settings"
+            else:
+                print("")
+                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                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("E. Back\n")
+
+            print(colored("Configuration options", attrs=["underline"]))
+            print("1. Edit pinned projects [WIP]")
+            print("2. Change program's color [WIP]\n")
+
+            print(colored("Other options", attrs=["underline"]))
+            print("3. Open memory.ini manually")
+            print("4. Open the Projects folder")
+            print("5. Open the Templates folder\n")
+
+            choice = input(f"{self.user_path}> ").strip()
+
+            if choice.lower() == "e":
+                return
+            #elif choice == "1":
+                #pass
+            #elif choice == "2":
+                #pass
+            elif choice == "3":
+                Opener.open(self.config.memory_ini)
+            elif choice == "4":
+                Opener.open(self.config.projects_folder)
+            elif choice == "5":
+                Opener.open(self.config.templates_folder)
+            else:
+                print("")
+                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                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("E. Back\n")
+
+            print("1. Create a new profile")
+            print("2. Switch profiles\n")
+
+            choice = input(f"{self.user_path}> ").strip()
+
+            if choice.lower() == "e":
+                return
+            elif choice == "1":
+                self.new_profile()
+            elif choice == "2":
+                self.switch_profile()
+            else:
+                print("")
+                print(colored("Unknown option...", "light_red", attrs=["blink"]))
+                time.sleep(1)
+
+    def switch_profile(self):
+        while True:
+            prof_dir = self.config.profile_dir
+            contents = os.listdir(prof_dir)
+
+            print("\nYour profiles:")
+            for item in contents:
+                print(colored(f" - {item}", f"{self.color}"))
+
+            name = input("\nProfile name > ").strip()
+
+            if name in contents:
+                self.config.update_memory("CONFIG", "profile", name)
+
+                self.memory = self.config.load_memory()
+
+                profile = self.memory.get('profile')
+                self.config = ConfigManager("memory.ini", profile=profile)
+
+                self.memory = self.config.load_memory()
+                self.active_profile = self.memory.get('profile')
+                return
+            else:
+                print(colored("\nInvalid name!", "yellow"))
+                time.sleep(1)
+                os.system(self.clear)
+
+    def new_profile(self):
+        name = input("\nNew profile name > ").strip()
+
+        profile_dir = self.config.profile_dir / name
+        profile_dir.mkdir(parents=True, exist_ok=True)
+
+        (profile_dir / "Projects").mkdir(exist_ok=True)
+        (profile_dir / "Templates").mkdir(exist_ok=True)
+
+        default_templates = resources.files("da.templates")
+        for item in default_templates.iterdir():
+            dest = profile_dir / "Templates"
+            shutil.copy(item, dest)
+
+        self.config.update_memory("CONFIG", "profile", name)
+
+        self.memory = self.config.load_memory()
+
+        profile = self.memory.get('profile')
+        self.config = ConfigManager("memory.ini", profile=profile)
+
+        self.memory = self.config.load_memory()
+        self.active_profile = self.memory.get('profile')
+        return
+
+    def runtime_init(self):
+        if not self.config.memory_ini.exists():
+            self.local_init()
+            self.first_run = True
+
+        self.memory = self.config.load_memory()
+        active_profile = self.memory.get("profile") or "Default"
+
+        self.config = ConfigManager("memory.ini", profile=active_profile)
+        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')
+
+    def local_init(self):
+        default_files = resources.files("da.default")
+        dest = self.config.memory_ini
+
+        for item in default_files.iterdir():
+            if item.name == "default-memory.ini":
+                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":
+                shutil.copy(item, dest)
+
+    def intro(self):
+        os.system(self.clear)
+        print(colored("Welcome to the Developer Assistant\n", f"{self.color}", attrs=["bold"]))
+        print("Here's everything you need to get started...\n")
+
+        time.sleep(2)
+
+        readme_content = resources.files("da").joinpath("intro.md").read_text()
+
+        MARKDOWN = readme_content
+        console = Console()
+        md = Markdown(MARKDOWN)
+        console.print(md)
+
+        input("\nContinue..." + colored("[Enter]", f"{self.color}"))
+
+def main():
+    try:
+        app = Interface()
+        app.run()
+    except KeyboardInterrupt:
+        print("\n\n" + colored("Execution interrupted. Exiting...", "cyan", attrs=["bold"]))
+        time.sleep(1)
+        sys.exit(0)
+
+if __name__ == "__main__":
+    main()