@tmlmobilidade/generate-offer-files 20250625.1555.11 → 20250625.1613.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
### @tmlmobilidade/generate-offer-files
|
|
2
|
+
|
|
3
|
+
Este script assume que os ficheiros GTFS dos operadores vêm no formato pedido pela TML; i.e. cumprem os requisitos indicados nesta página: https://docs.google.com/spreadsheets/d/1RUa5FYvKcpcu6bEdG4DFV2OQAhsngWB1dqTY9vSgIQo/edit?gid=2058239706#gid=2058239706
|
|
4
|
+
|
|
5
|
+
Para utilizar o script é necessário ter o NodeJS/NPM instalado. Seguir os passos aqui: https://nodejs.org/en/download
|
|
6
|
+
|
|
7
|
+
#### Para obter instruções de utilização do script:
|
|
8
|
+
|
|
9
|
+
`npx @tmlmobilidade/generate-offer-files --help`
|
|
10
|
+
|
|
11
|
+
#### Para correr o script para um ficheiro GTFS da Fertagus, por exemplo:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
npx @tmlmobilidade/generate-offer-files \
|
|
15
|
+
--file=Fertagus_GTFS.zip \
|
|
16
|
+
--start-date=20250625 \
|
|
17
|
+
--end-date=20250625 \
|
|
18
|
+
--feed-id=123
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
#### Explicação dos parâmetros:
|
|
22
|
+
- `--file` é o caminho para o ficheiro .zip a ser processado
|
|
23
|
+
- `--start-date` é a primeira data a incluir nos ficheiros gerados, mesmo que o GTFS contenha oferta antes.
|
|
24
|
+
- `--end-date` é a última data a incluir nos ficheiros gerados, mesmo que o GTFS contenha oferta depois.
|
|
25
|
+
- `--feed-id` campo opcional a incluir nos ficheiros finais para mais fácil identificação depois da integração.
|
|
26
|
+
|
|
27
|
+
#### Opções adicionais:
|
|
28
|
+
- `--output-dir` caminho do diretório onde serão gerados os ficheiros finais. Defaults to ‘./output’
|
|
29
|
+
- `--override` ao incluir este parâmetro o diretório de output-dir será substituído com a nova geração.
|