Skip to main content

A lightweight TUI designed to simplify formatting of Markdown changelogs.

Project description

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 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.

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.

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.

Using the program.

  1. What not to do

Don't change the folder structure or modify variable names inside .ini files.

  1. 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 will be created automatically.

You can access its content quickly when going to: Main menu / Settings

  • 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 applied to the real changelog after 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

  • Custom colour

Last project gets updated automatically, the rest are up to you.

  • 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.

Now make an optional test-project/ folder with a CHANGELOG.md in it anywhere on your system 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

developer_assistant-0.2.5.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

developer_assistant-0.2.5-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file developer_assistant-0.2.5.tar.gz.

File metadata

  • Download URL: developer_assistant-0.2.5.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for developer_assistant-0.2.5.tar.gz
Algorithm Hash digest
SHA256 7df92458b8e9294a5ba1570bfa0c4d30804dc06fa9a16e5ffaee71e1a9f4622c
MD5 2113dbaba374aef426c5c7587b292294
BLAKE2b-256 5c3ca46863c5d1978ec8bc1ce9fdead2febf88fb6095e416f131337e65a76e2b

See more details on using hashes here.

File details

Details for the file developer_assistant-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: developer_assistant-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for developer_assistant-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fe627b3ec0fde0dc7fe9cbe15e29cd02a1921f45a78ac3197d5a80e6b096296b
MD5 b1ae6b40cca7942fb6a74fa10cea2406
BLAKE2b-256 95c538e79c92b9ef7d92a11a87e0f4ddb2f2240724d288e73be2bb0a38114525

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page