You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
**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.
8
8
9
9
## 🎯 Perché Markdown per le norme?
10
10
@@ -35,22 +35,19 @@ Convertire le norme legali da XML Akoma Ntoso a Markdown offre vantaggi signific
35
35
36
36
### Installazione da PyPI (Raccomandato)
37
37
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`.
39
39
40
40
```bash
41
41
# Con uv
42
-
uv tool install akoma2md
42
+
uv tool install normattiva2md
43
43
44
44
# Con pip
45
-
pip install akoma2md
45
+
pip install normattiva2md
46
46
47
-
# Utilizzo (entrambi i comandi funzionano)
48
-
normattiva2md input.xml output.md # Nuovo comando raccomandato
> **💡 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
-
54
51
### Configurazione Exa AI API (opzionale - per ricerca in linguaggio naturale)
55
52
56
53
Per utilizzare la funzionalità di ricerca in linguaggio naturale (`--search`), è necessario configurare una [API key di Exa AI](https://exa.ai).
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.
6
6
7
7
## 2. Scopo
8
8
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.
10
10
11
11
## 3. Funzionalità
12
12
@@ -39,9 +39,9 @@ L'obiettivo principale di `akoma2md` è fornire un modo semplice ed efficiente p
39
39
40
40
### 3.3. Interfaccia a Riga di Comando (CLI)
41
41
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`).
45
45
***Opzioni Avanzate:** Flag per mantenere file XML temporanei scaricati (`--keep-xml`).
46
46
***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.
47
47
***Messaggi di Successo:** Conferma della corretta conversione con dettagli sui file generati.
0 commit comments