Skip to content

Commit 617af91

Browse files
committed
docs: remove all akoma2md references from documentation
- Updated README.md to use only normattiva2md - Updated docs/index.md (onepage site) to use normattiva2md - Updated docs/README.md, docs/NORMATTIVA_API.md, docs/PRD.md - Removed compatibility notes and legacy command examples - All installation instructions now point to normattiva2md package
1 parent 5d6d323 commit 617af91

5 files changed

Lines changed: 23 additions & 32 deletions

File tree

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# 🔄 Normattiva2MD - Convertitore Akoma Ntoso in Markdown
22

3-
[![Versione PyPI](https://img.shields.io/pypi/v/akoma2md.svg)](https://pypi.org/project/akoma2md/)
3+
[![Versione PyPI](https://img.shields.io/pypi/v/normattiva2md.svg)](https://pypi.org/project/normattiva2md/)
44
[![Versione Python](https://img.shields.io/badge/python-3.7+-blue.svg)](https://python.org)
55
[![Licenza](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
66

7-
**Akoma2MD** è uno strumento da riga di comando progettato per convertire documenti XML in formato **Akoma Ntoso** (in particolare le norme pubblicate su `normattiva.it`) in documenti **Markdown** leggibili e ben formattati. L'obiettivo principale è offrire un formato compatto e immediatamente riutilizzabile quando le norme devono essere fornite come contesto a un **Large Language Model (LLM)** o elaborate in pipeline di Intelligenza Artificiale.
7+
**Normattiva2MD** è uno strumento da riga di comando progettato per convertire documenti XML in formato **Akoma Ntoso** (in particolare le norme pubblicate su `normattiva.it`) in documenti **Markdown** leggibili e ben formattati. L'obiettivo principale è offrire un formato compatto e immediatamente riutilizzabile quando le norme devono essere fornite come contesto a un **Large Language Model (LLM)** o elaborate in pipeline di Intelligenza Artificiale.
88

99
## 🎯 Perché Markdown per le norme?
1010

@@ -35,22 +35,19 @@ Convertire le norme legali da XML Akoma Ntoso a Markdown offre vantaggi signific
3535

3636
### Installazione da PyPI (Raccomandato)
3737

38-
Il pacchetto è pubblicato su [PyPI](https://pypi.org/project/akoma2md/) come `akoma2md`.
38+
Il pacchetto è pubblicato su [PyPI](https://pypi.org/project/normattiva2md/) come `normattiva2md`.
3939

4040
```bash
4141
# Con uv
42-
uv tool install akoma2md
42+
uv tool install normattiva2md
4343

4444
# Con pip
45-
pip install akoma2md
45+
pip install normattiva2md
4646

47-
# Utilizzo (entrambi i comandi funzionano)
48-
normattiva2md input.xml output.md # Nuovo comando raccomandato
49-
akoma2md input.xml output.md # Vecchio comando (compatibilità)
47+
# Utilizzo
48+
normattiva2md input.xml output.md
5049
```
5150

52-
> **💡 Nota sulla compatibilità**: Entrambi i comandi `normattiva2md` e `akoma2md` funzionano identicamente. Il nuovo nome `normattiva2md` è raccomandato per chiarezza, ma il vecchio comando rimane disponibile per compatibilità durante la transizione.
53-
5451
### Configurazione Exa AI API (opzionale - per ricerca in linguaggio naturale)
5552

5653
Per utilizzare la funzionalità di ricerca in linguaggio naturale (`--search`), è necessario configurare una [API key di Exa AI](https://exa.ai).
@@ -92,8 +89,7 @@ normattiva2md -s "legge stanca accessibilità" --exa-api-key "your-exa-api-key"
9289
git clone https://github.com/aborruso/normattiva_2_md.git
9390
cd normattiva_2_md
9491
pip install -e .
95-
normattiva2md input.xml output.md # Nuovo comando raccomandato
96-
# Oppure: akoma2md input.xml output.md # Vecchio comando (compatibilità)
92+
normattiva2md input.xml output.md
9793
```
9894

9995
### Esecuzione diretta (senza installazione)

docs/NORMATTIVA_API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ I risultati sono presentati come pagina HTML con:
6363
- **Nessuna documentazione**: Le API non sono documentate ufficialmente
6464
- **Fragilità**: Cambiamenti alla struttura HTML romperebbero il parsing
6565

66-
## Soluzione attuale in akoma2md
66+
## Soluzione attuale in normattiva2md
6767

68-
Il progetto akoma2md usa **Gemini CLI** come intermediario intelligente per:
68+
Il progetto normattiva2md usa **Gemini CLI** come intermediario intelligente per:
6969

7070
1. Interpretare query in linguaggio naturale
7171
2. Cercare su normattiva.it
@@ -147,7 +147,7 @@ Se normattiva.it pubblicasse API JSON ufficiali, si potrebbero implementare:
147147
## Risorse
148148

149149
- Sito: https://www.normattiva.it
150-
- Progetto akoma2md: https://github.com/aborruso/normattiva_2_md
150+
- Progetto normattiva2md: https://github.com/aborruso/normattiva_2_md
151151
- Gemini CLI: https://github.com/google-gemini/gemini-cli
152152

153153
## Aggiornamenti

docs/PRD.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Product Requirements Document (PRD) - akoma2md
1+
# Product Requirements Document (PRD) - normattiva2md
22

33
## 1. Introduzione
44

5-
Questo documento descrive i requisiti per `akoma2md`, uno strumento a riga di comando progettato per convertire file XML conformi allo standard Akoma Ntoso in documenti Markdown leggibili. La finalità di base è produrre file facilmente condivisibili con modelli linguistici di grandi dimensioni (LLM) e altri sistemi di Intelligenza Artificiale, così da semplificare analisi, verifica e automazione dei contenuti normativi.
5+
Questo documento descrive i requisiti per `normattiva2md`, uno strumento a riga di comando progettato per convertire file XML conformi allo standard Akoma Ntoso in documenti Markdown leggibili. La finalità di base è produrre file facilmente condivisibili con modelli linguistici di grandi dimensioni (LLM) e altri sistemi di Intelligenza Artificiale, così da semplificare analisi, verifica e automazione dei contenuti normativi.
66

77
## 2. Scopo
88

9-
L'obiettivo principale di `akoma2md` è fornire un modo semplice ed efficiente per convertire le norme pubblicate su `normattiva.it` (esportabili in formato Akoma Ntoso) in documenti Markdown. Questo formato testuale strutturato è ideale per essere utilizzato come input per Large Language Models (LLM) e sistemi di Intelligenza Artificiale, facilitando la creazione di bot specializzati basati su normative legali. In particolare, il progetto mira a rendere immediato il passaggio da XML complessi a Markdown pronto per essere incollato o caricato come contesto in strumenti LLM, riducendo tempi di preparazione e rischio di errori.
9+
L'obiettivo principale di `normattiva2md` è fornire un modo semplice ed efficiente per convertire le norme pubblicate su `normattiva.it` (esportabili in formato Akoma Ntoso) in documenti Markdown. Questo formato testuale strutturato è ideale per essere utilizzato come input per Large Language Models (LLM) e sistemi di Intelligenza Artificiale, facilitando la creazione di bot specializzati basati su normative legali. In particolare, il progetto mira a rendere immediato il passaggio da XML complessi a Markdown pronto per essere incollato o caricato come contesto in strumenti LLM, riducendo tempi di preparazione e rischio di errori.
1010

1111
## 3. Funzionalità
1212

@@ -39,9 +39,9 @@ L'obiettivo principale di `akoma2md` è fornire un modo semplice ed efficiente p
3939

4040
### 3.3. Interfaccia a Riga di Comando (CLI)
4141

42-
* **Argomenti Posizionali:** Supporto per l'input e l'output come argomenti posizionali (es. `akoma2md input.xml output.md`).
43-
* **Argomenti Nominati:** Supporto per argomenti nominati per input e output (es. `akoma2md -i input.xml -o output.md` o `akoma2md --input input.xml --output output.md`).
44-
* **Input da URL:** Supporto diretto per URL normattiva.it come input (es. `akoma2md "https://www.normattiva.it/..." output.md`).
42+
* **Argomenti Posizionali:** Supporto per l'input e l'output come argomenti posizionali (es. `normattiva2md input.xml output.md`).
43+
* **Argomenti Nominati:** Supporto per argomenti nominati per input e output (es. `normattiva2md -i input.xml -o output.md` o `normattiva2md --input input.xml --output output.md`).
44+
* **Input da URL:** Supporto diretto per URL normattiva.it come input (es. `normattiva2md "https://www.normattiva.it/..." output.md`).
4545
* **Opzioni Avanzate:** Flag per mantenere file XML temporanei scaricati (`--keep-xml`).
4646
* **Messaggi di Errore:** Fornire messaggi di errore chiari in caso di file mancanti, errori di parsing XML, problemi di rete o problemi di scrittura del file.
4747
* **Messaggi di Successo:** Conferma della corretta conversione con dettagli sui file generati.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ Modifica `_layouts/default.html` per cambiare header, footer o struttura HTML.
9090

9191
- **Sito live**: https://aborruso.github.io/normattiva_2_md/
9292
- **Repository**: https://github.com/aborruso/normattiva_2_md
93-
- **PyPI Package**: https://pypi.org/project/akoma2md/
93+
- **PyPI Package**: https://pypi.org/project/normattiva2md/
9494
- **Documentazione**: https://github.com/aborruso/normattiva_2_md/blob/main/README.md

docs/index.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ title: Converti leggi italiane in Markdown AI-ready
2929
<div class="bg-gray-900 bg-opacity-50 backdrop-blur-sm rounded-lg p-6 max-w-2xl mx-auto">
3030
<div class="text-left">
3131
<div class="text-sm text-blue-200 mb-2">Quick Install</div>
32-
<pre class="text-left"><code class="language-bash">pip install akoma2md
32+
<pre class="text-left"><code class="language-bash">pip install normattiva2md
3333
normattiva2md "https://normattiva.it/..." output.md</code></pre>
3434
</div>
3535
</div>
@@ -302,7 +302,7 @@ dataVigenza: 20250130
302302
</p>
303303
<div class="bg-gray-900 rounded-lg overflow-hidden mb-6">
304304
<pre><code class="language-bash"># Installa da PyPI
305-
pip install akoma2md
305+
pip install normattiva2md
306306

307307
# Verifica installazione
308308
normattiva2md --version
@@ -316,11 +316,6 @@ normattiva2md input.xml output.md
316316
# Output a stdout (per piping)
317317
normattiva2md input.xml > output.md</code></pre>
318318
</div>
319-
<div class="bg-blue-50 border-l-4 border-blue-500 p-4">
320-
<p class="text-sm text-gray-700">
321-
<span class="font-semibold">Nota:</span> Entrambi i comandi <code class="bg-white px-2 py-1 rounded">normattiva2md</code> e <code class="bg-white px-2 py-1 rounded">akoma2md</code> funzionano identicamente.
322-
</p>
323-
</div>
324319
</div>
325320
</div>
326321

@@ -335,8 +330,8 @@ normattiva2md input.xml > output.md</code></pre>
335330
<pre><code class="language-bash"># Installa uv (se non già installato)
336331
curl -LsSf https://astral.sh/uv/install.sh | sh
337332

338-
# Installa akoma2md come tool
339-
uv tool install akoma2md
333+
# Installa normattiva2md come tool
334+
uv tool install normattiva2md
340335

341336
# Uso
342337
normattiva2md "URL" output.md</code></pre>
@@ -430,7 +425,7 @@ normattiva2md "https://www.normattiva.it/uri-res/N2Ls?urn:nir:stato:decreto.legi
430425
</svg>
431426
Documentazione
432427
</a>
433-
<a href="https://pypi.org/project/akoma2md/" target="_blank" class="inline-flex items-center gap-2 bg-gray-200 text-gray-800 px-6 py-3 rounded-lg hover:bg-gray-300 transition">
428+
<a href="https://pypi.org/project/normattiva2md/" target="_blank" class="inline-flex items-center gap-2 bg-gray-200 text-gray-800 px-6 py-3 rounded-lg hover:bg-gray-300 transition">
434429
<svg class="w-5 h-5" fill="none" stroke="currentColor" viewBox="0 0 24 24">
435430
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M20 7l-8-4-8 4m16 0l-8 4m8-4v10l-8 4m0-10L4 7m8 4v10M4 7v10l8 4"></path>
436431
</svg>

0 commit comments

Comments
 (0)