1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-12 15:27:14 +03:00

Document use of *local* outfitting.csv instead of FDevIDs version

That's in collate.py and coriolis.py docstrings.
This commit is contained in:
Athanasius 2021-12-17 12:23:20 +00:00
parent c45b99a180
commit da4ae24440
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
2 changed files with 13 additions and 1 deletions

View File

@ -5,6 +5,11 @@ Collate lists of seen commodities, modules and ships from dumps of the Companion
Note that currently this will only work with the output files created if you
run the main program from a working directory that has a `dump/` directory,
which causes a file to be written per CAPI query.
This script also utilise the file outfitting.csv. As it both reads it in *and*
writes out a new copy a local copy, in the root of the project structure, is
used for this purpose. If you want to utilise the FDevIDs/ version of the
file, copy it over the local one.
"""
import csv

View File

@ -1,5 +1,12 @@
#!/usr/bin/env python3
"""Build ship and module databases from https://github.com/EDCD/coriolis-data/ ."""
"""
Build ship and module databases from https://github.com/EDCD/coriolis-data/ .
This script also utilise the file outfitting.csv. Due to how collate.py
both reads and writes to this file a local copy is used, in the root of the
project structure, is used for this purpose. If you want to utilise the
FDevIDs/ version of the file, copy it over the local one.
"""
import csv