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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: developer-assistant
-Version: 0.2.5
-Summary: A lightweight TUI designed to simplify formatting of Markdown changelogs.
+Version: 0.3.5
+Summary: A lightweight TUI app for managing and simplifying your Markdown changelogs.
 License: The MIT License (MIT)
         
         Copyright (c) 2026 Ivori Huobolainen
@@ -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,14 +53,15 @@ 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 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 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, 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 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.
@@ -78,30 +79,58 @@ Don't change the folder structure or modify variable names inside `.ini` files.
 
 * 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*
+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. 
 
-- *Safe changelog updates*
+[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. 
-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:
 
@@ -109,15 +138,18 @@ The `memory.ini` file does exactly what you'd expect, it features:
 
 * Pinned projects
 
+* Active profile
+
 * Custom colour
 
-Last project gets updated automatically, the rest are up to you.
+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.*
 
-### 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.5/PYPI.md

@@ -0,0 +1,127 @@
+# 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`
+
+**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 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, 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.
+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**.
+
+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. 
+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.5/README.md

@@ -0,0 +1,169 @@
+# 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.**
+
+> `pip install developer-assistant`
+
+* **Installation:** detailed instructions in [SETUP](./SETUP.md)
+
+* **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
+A comfortable interface with a modern polish, built the good old way:
+
+![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, 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.
+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.
+
+> [!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.
+
+> [!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. 
+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.
+
+> [!TIP] 
+> **`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:** 
+```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*
+
+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.5 → developer_assistant-0.3.5}/da/default/default-memory.ini

@@ -5,5 +5,6 @@ pinned_project1 =
 pinned_project2 = 
 
 [CONFIG]
+profile = Default
 color = 
 

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

@@ -0,0 +1,9 @@
+[SETTINGS]
+edited = 
+owner = Default
+path = C:\Users\...\Developer-Assistant\test-project
+changelog = C:\Users\...\Developer-Assistant\test-project\CHANGELOG.md
+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 =