diff --git a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy.py b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy.py index 696609c0dfc449abe5c8daf0072580583d700770..e2b7bb4b522b1929c8ba43c768fc8725ac3fb7b3 100644 --- a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy.py +++ b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy.py @@ -1,3 +1,12 @@ +""" +survey_publisher_legacy +========================= + +This script is used to import data from the legacy datasources into the new survey system. +Legacy data is used to generate a new survey for each NREN, for each year that we have data for. +The generated surveys are based on the 2024 survey. + +""" import click from itertools import chain from collections import defaultdict diff --git a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_db.py b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_db.py index e8f7c5ffcf47112b7159ce81ba61b8e93617fec8..4d12a84e01cf8b4a5ed04d3b98becbd49dd1783b 100644 --- a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_db.py +++ b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_db.py @@ -1,8 +1,9 @@ """ -survey_publisher_old_db_2022 +survey_publisher_legacy_db ============================ -This module loads the survey data from 2022 from the old survey database and returns the data. +This module loads the survey data from 2022 from the old survey database and returns the data +ready to be used to generate new-style surveys. """ from decimal import Decimal diff --git a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_excel.py b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_excel.py index a41fba86fdcb6ba71ab60b07bcd426b888e6452e..145ca1fe6ddfa973ba04d9593c18aceeffdbe122 100644 --- a/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_excel.py +++ b/compendium_v2/publishers/legacy_publisher/survey_publisher_legacy_excel.py @@ -1,10 +1,10 @@ """ -survey_publisher_v1 +survey_publisher_legacy_excel ========================= -This module loads the survey data from before 2022 from a legacy Excel files. +This module loads the survey data from before 2022 from a legacy Excel file. Missing info is filled in from the survey db for some questions. -Registered as click cli command when installing compendium-v2. +Returns the data ready to be used to generate new-style surveys. """ from __future__ import annotations diff --git a/docs/source/commands.rst b/docs/source/commands.rst index 1496cdb48f2a9c5092c4d825ca4495500d02b2d5..0a0eab28a233d7164c38df37c0e726ea36a0e83e 100644 --- a/docs/source/commands.rst +++ b/docs/source/commands.rst @@ -6,10 +6,13 @@ Commands .. contents:: :local: -.. automodule:: compendium_v2.publishers.survey_publisher_legacy_excel +.. automodule:: compendium_v2.publishers.legacy_publisher.survey_publisher_legacy :members: -.. automodule:: compendium_v2.publishers.survey_publisher_old_db_2022 +.. automodule:: compendium_v2.publishers.legacy_publisher.survey_publisher_legacy_db + :members: + +.. automodule:: compendium_v2.publishers.legacy_publisher.survey_publisher_legacy_excel :members: .. automodule:: compendium_v2.conversion.conversion diff --git a/setup.py b/setup.py index 8a14ac19cb308848d83f4fea34e055f3234e0969..896c3dec4a1d72cce81b5c3b8528b1588a799f2c 100644 --- a/setup.py +++ b/setup.py @@ -30,8 +30,6 @@ setup( include_package_data=True, entry_points={ 'console_scripts': [ - 'excel-survey-publisher=compendium_v2.publishers.survey_publisher_legacy_excel:cli', - 'db-publisher-2022=compendium_v2.publishers.survey_publisher_old_db_2022:cli', 'conversion=compendium_v2.conversion.conversion:cli', 'dump_survey_model=compendium_v2.migrations.dump_survey_model:cli', 'legacy-survey-publisher=compendium_v2.publishers.legacy_publisher.survey_publisher_legacy:cli',