Uno strumento per gestire note di sviluppo e task di progetto
Project description
DevNotes
Un tool per gestire note di sviluppo e task di progetto.
Caratteristiche
- Gestione dei task di progetto
- Analisi della struttura del codice
- Generazione di diagrammi Mermaid
- Visualizzazione delle relazioni tra funzioni
Installazione
pip install devnotes
Per utilizzare la funzionalità di rendering dei diagrammi, è necessario installare mermaid-cli:
npm install -g @mermaid-js/mermaid-cli
Oppure per lo sviluppo:
git clone https://github.com/tuousername/devnotes.git
cd devnotes
pip install -e ".[dev]"
Utilizzo
Inizializzazione
devnotes init
Gestione dei task
# Aggiungere un nuovo task
devnotes task-add-interactive
# Visualizzare tutti i task
devnotes task-list
# Modificare un task esistente
devnotes task-edit
# Marcare un task come completato
devnotes task-done 001
Analisi del codice
# Scansionare il progetto
devnotes scan
Diagrammi
# Generare un diagramma dei task
devnotes diagram tasks
# Generare un grafo delle chiamate
devnotes diagram callgraph
# Generare un diagramma gerarchico
devnotes diagram hierarchy
# Generare un diagramma e renderizzarlo
devnotes diagram tasks --render
# Generare un diagramma, renderizzarlo e aprilo nel browser
devnotes diagram callgraph --open
# Renderizzare un diagramma Mermaid in SVG
devnotes render --path .project/call_graph.mmd
Configurazione
Le impostazioni sono salvate in .project/settings.yaml. È possibile aggiornare le impostazioni con:
devnotes update
Build e Pubblicazione
Utilizzo del Makefile
# Mostra i comandi disponibili
make help
# Esegui tutte le operazioni fino alla build
make all
# Pubblica su PyPI
make publish
# Pubblica su TestPyPI
make publish-test
# Installa in modalità sviluppo
make install-dev
Utilizzo dello script Bash
# Rendi lo script eseguibile
chmod +x build_publish.sh
# Mostra i comandi disponibili
./build_publish.sh --help
# Esegui tutte le operazioni fino alla build
./build_publish.sh --all
# Pubblica su PyPI
./build_publish.sh --build --publish
# Pubblica su TestPyPI
./build_publish.sh --build --test-publish
# Installa in modalità sviluppo
./build_publish.sh --dev
Requisiti
- Python 3.8+
- Mermaid CLI (opzionale, per la renderizzazione dei diagrammi)
Licenza
MIT
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file devnotes-0.1.1.tar.gz.
File metadata
- Download URL: devnotes-0.1.1.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9+
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b85cda36cad74e06228c5b17200eefd73438fbf80ef2c11d83fb78fbff97ec65
|
|
| MD5 |
207441c9e98c7a9bf86f12dc4a32b2c9
|
|
| BLAKE2b-256 |
e7e941243c2964590ee3a1877031e8721cb59519075bb1982bfa917d34d59d70
|
File details
Details for the file devnotes-0.1.1-py3-none-any.whl.
File metadata
- Download URL: devnotes-0.1.1-py3-none-any.whl
- Upload date:
- Size: 12.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9+
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
556e9e2e0bdb7dd6d9b7b4a3024efefffa53c99249ebe300f7bdff93ff5ba216
|
|
| MD5 |
482fbb9fec374b93f65c409f9b677289
|
|
| BLAKE2b-256 |
deccec09d43f1ba66a17be7e09df36c687619ac67eb02a7cbd090063a9c103d6
|