Adopt src code layout

Also ensures that .tox/.doctrees tmp location is used instead of .tmp/.doctrees which was not a gitignored location and also polluted the root project directory. Fixes: #551
ansible · Sep 2, 2021 · 05483d3 · 05483d3
1 parent a69f52b
commit 05483d3
Show file tree

Hide file tree

Showing 93 changed files with 6 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -224,7 +224,7 @@
     "--implicit-namespaces",
     "--private",  # include “_private” modules
 ]
-apidoc_module_dir = "../ansible_navigator"
+apidoc_module_dir = "../src/ansible_navigator"
 apidoc_module_first = False
 apidoc_output_dir = "pkg"
 apidoc_separate_modules = True

diff --git a/setup.cfg b/setup.cfg
@@ -31,6 +31,8 @@ classifiers =
     Programming Language :: Python :: Implementation :: PyPy
 
 [options]
+package_dir =
+  = src
 packages = find:
 install_requires =
     ansible-runner >=2,<3
@@ -46,6 +48,7 @@ console_scripts =
     ansible-navigator=ansible_navigator.cli:main
 
 [options.packages.find]
+where = src
 exclude =
     tests*
     testing*
diff --git a/ansible_navigator/__init__.py → src/ansible_navigator/__init__.py b/ansible_navigator/__init__.py → src/ansible_navigator/__init__.py
diff --git a/ansible_navigator/__main__.py → src/ansible_navigator/__main__.py b/ansible_navigator/__main__.py → src/ansible_navigator/__main__.py
diff --git a/ansible_navigator/_version.py → src/ansible_navigator/_version.py b/ansible_navigator/_version.py → src/ansible_navigator/_version.py
diff --git a/ansible_navigator/action_runner.py → src/ansible_navigator/action_runner.py b/ansible_navigator/action_runner.py → src/ansible_navigator/action_runner.py
diff --git a/ansible_navigator/actions/__init__.py → src/ansible_navigator/actions/__init__.py b/ansible_navigator/actions/__init__.py → src/ansible_navigator/actions/__init__.py
diff --git a/ansible_navigator/actions/_actions.py → src/ansible_navigator/actions/_actions.py b/ansible_navigator/actions/_actions.py → src/ansible_navigator/actions/_actions.py
diff --git a/ansible_navigator/actions/back.py → src/ansible_navigator/actions/back.py b/ansible_navigator/actions/back.py → src/ansible_navigator/actions/back.py
diff --git a/ansible_navigator/actions/collections.py → src/ansible_navigator/actions/collections.py b/ansible_navigator/actions/collections.py → src/ansible_navigator/actions/collections.py
diff --git a/ansible_navigator/actions/config.py → src/ansible_navigator/actions/config.py b/ansible_navigator/actions/config.py → src/ansible_navigator/actions/config.py
diff --git a/ansible_navigator/actions/doc.py → src/ansible_navigator/actions/doc.py b/ansible_navigator/actions/doc.py → src/ansible_navigator/actions/doc.py
diff --git a/ansible_navigator/actions/filter.py → src/ansible_navigator/actions/filter.py b/ansible_navigator/actions/filter.py → src/ansible_navigator/actions/filter.py
diff --git a/ansible_navigator/actions/help_doc.py → src/ansible_navigator/actions/help_doc.py b/ansible_navigator/actions/help_doc.py → src/ansible_navigator/actions/help_doc.py
diff --git a/ansible_navigator/actions/images.py → src/ansible_navigator/actions/images.py b/ansible_navigator/actions/images.py → src/ansible_navigator/actions/images.py
diff --git a/ansible_navigator/actions/inventory.py → src/ansible_navigator/actions/inventory.py b/ansible_navigator/actions/inventory.py → src/ansible_navigator/actions/inventory.py
diff --git a/ansible_navigator/actions/log.py → src/ansible_navigator/actions/log.py b/ansible_navigator/actions/log.py → src/ansible_navigator/actions/log.py
diff --git a/ansible_navigator/actions/open_file.py → src/ansible_navigator/actions/open_file.py b/ansible_navigator/actions/open_file.py → src/ansible_navigator/actions/open_file.py
diff --git a/ansible_navigator/actions/quit.py → src/ansible_navigator/actions/quit.py b/ansible_navigator/actions/quit.py → src/ansible_navigator/actions/quit.py
diff --git a/ansible_navigator/actions/refresh.py → src/ansible_navigator/actions/refresh.py b/ansible_navigator/actions/refresh.py → src/ansible_navigator/actions/refresh.py
diff --git a/ansible_navigator/actions/replay.py → src/ansible_navigator/actions/replay.py b/ansible_navigator/actions/replay.py → src/ansible_navigator/actions/replay.py
diff --git a/ansible_navigator/actions/rerun.py → src/ansible_navigator/actions/rerun.py b/ansible_navigator/actions/rerun.py → src/ansible_navigator/actions/rerun.py
diff --git a/ansible_navigator/actions/run.py → src/ansible_navigator/actions/run.py b/ansible_navigator/actions/run.py → src/ansible_navigator/actions/run.py
diff --git a/ansible_navigator/actions/sample_form.py → src/ansible_navigator/actions/sample_form.py b/ansible_navigator/actions/sample_form.py → src/ansible_navigator/actions/sample_form.py
diff --git a/..._navigator/actions/sample_notification.py → ..._navigator/actions/sample_notification.py b/..._navigator/actions/sample_notification.py → ..._navigator/actions/sample_notification.py
diff --git a/ansible_navigator/actions/sample_working.py → ...sible_navigator/actions/sample_working.py b/ansible_navigator/actions/sample_working.py → ...sible_navigator/actions/sample_working.py
diff --git a/ansible_navigator/actions/save.py → src/ansible_navigator/actions/save.py b/ansible_navigator/actions/save.py → src/ansible_navigator/actions/save.py
diff --git a/ansible_navigator/actions/select.py → src/ansible_navigator/actions/select.py b/ansible_navigator/actions/select.py → src/ansible_navigator/actions/select.py
diff --git a/ansible_navigator/actions/serialize_json.py → ...sible_navigator/actions/serialize_json.py b/ansible_navigator/actions/serialize_json.py → ...sible_navigator/actions/serialize_json.py
diff --git a/ansible_navigator/actions/serialize_yaml.py → ...sible_navigator/actions/serialize_yaml.py b/ansible_navigator/actions/serialize_yaml.py → ...sible_navigator/actions/serialize_yaml.py
diff --git a/ansible_navigator/actions/stdout.py → src/ansible_navigator/actions/stdout.py b/ansible_navigator/actions/stdout.py → src/ansible_navigator/actions/stdout.py
diff --git a/ansible_navigator/actions/template.py → src/ansible_navigator/actions/template.py b/ansible_navigator/actions/template.py → src/ansible_navigator/actions/template.py
diff --git a/ansible_navigator/actions/welcome.py → src/ansible_navigator/actions/welcome.py b/ansible_navigator/actions/welcome.py → src/ansible_navigator/actions/welcome.py
diff --git a/ansible_navigator/actions/write_file.py → src/ansible_navigator/actions/write_file.py b/ansible_navigator/actions/write_file.py → src/ansible_navigator/actions/write_file.py
diff --git a/ansible_navigator/app.py → src/ansible_navigator/app.py b/ansible_navigator/app.py → src/ansible_navigator/app.py
diff --git a/ansible_navigator/app_public.py → src/ansible_navigator/app_public.py b/ansible_navigator/app_public.py → src/ansible_navigator/app_public.py
diff --git a/ansible_navigator/cli.py → src/ansible_navigator/cli.py b/ansible_navigator/cli.py → src/ansible_navigator/cli.py
diff --git a/ansible_navigator/command_runner/__init__.py → ...ible_navigator/command_runner/__init__.py b/ansible_navigator/command_runner/__init__.py → ...ible_navigator/command_runner/__init__.py
diff --git a/...avigator/command_runner/command_runner.py → ...avigator/command_runner/command_runner.py b/...avigator/command_runner/command_runner.py → ...avigator/command_runner/command_runner.py
diff --git a/...gator/configuration_subsystem/__init__.py → ...gator/configuration_subsystem/__init__.py b/...gator/configuration_subsystem/__init__.py → ...gator/configuration_subsystem/__init__.py
diff --git a/...r/configuration_subsystem/configurator.py → ...r/configuration_subsystem/configurator.py b/...r/configuration_subsystem/configurator.py → ...r/configuration_subsystem/configurator.py
diff --git a/...or/configuration_subsystem/definitions.py → ...or/configuration_subsystem/definitions.py b/...or/configuration_subsystem/definitions.py → ...or/configuration_subsystem/definitions.py
diff --git a/...tion_subsystem/navigator_configuration.py → ...tion_subsystem/navigator_configuration.py b/...tion_subsystem/navigator_configuration.py → ...tion_subsystem/navigator_configuration.py
diff --git a/...ion_subsystem/navigator_post_processor.py → ...ion_subsystem/navigator_post_processor.py b/...ion_subsystem/navigator_post_processor.py → ...ion_subsystem/navigator_post_processor.py
diff --git a/...vigator/configuration_subsystem/parser.py → ...vigator/configuration_subsystem/parser.py b/...vigator/configuration_subsystem/parser.py → ...vigator/configuration_subsystem/parser.py
diff --git a/ansible_navigator/image_manager/__init__.py → ...sible_navigator/image_manager/__init__.py b/ansible_navigator/image_manager/__init__.py → ...sible_navigator/image_manager/__init__.py
diff --git a/ansible_navigator/image_manager/inspector.py → ...ible_navigator/image_manager/inspector.py b/ansible_navigator/image_manager/inspector.py → ...ible_navigator/image_manager/inspector.py
diff --git a/ansible_navigator/image_manager/puller.py → ...ansible_navigator/image_manager/puller.py b/ansible_navigator/image_manager/puller.py → ...ansible_navigator/image_manager/puller.py
diff --git a/ansible_navigator/initialization.py → src/ansible_navigator/initialization.py b/ansible_navigator/initialization.py → src/ansible_navigator/initialization.py
diff --git a/ansible_navigator/runner/__init__.py → src/ansible_navigator/runner/__init__.py b/ansible_navigator/runner/__init__.py → src/ansible_navigator/runner/__init__.py
diff --git a/ansible_navigator/runner/api.py → src/ansible_navigator/runner/api.py b/ansible_navigator/runner/api.py → src/ansible_navigator/runner/api.py
diff --git a/ansible_navigator/steps.py → src/ansible_navigator/steps.py b/ansible_navigator/steps.py → src/ansible_navigator/steps.py
diff --git a/ansible_navigator/tm_tokenize/LICENSE → src/ansible_navigator/tm_tokenize/LICENSE b/ansible_navigator/tm_tokenize/LICENSE → src/ansible_navigator/tm_tokenize/LICENSE
diff --git a/ansible_navigator/tm_tokenize/__init__.py → ...ansible_navigator/tm_tokenize/__init__.py b/ansible_navigator/tm_tokenize/__init__.py → ...ansible_navigator/tm_tokenize/__init__.py
diff --git a/ansible_navigator/tm_tokenize/_types.py → src/ansible_navigator/tm_tokenize/_types.py b/ansible_navigator/tm_tokenize/_types.py → src/ansible_navigator/tm_tokenize/_types.py
diff --git a/ansible_navigator/tm_tokenize/compiler.py → ...ansible_navigator/tm_tokenize/compiler.py b/ansible_navigator/tm_tokenize/compiler.py → ...ansible_navigator/tm_tokenize/compiler.py
diff --git a/ansible_navigator/tm_tokenize/fchainmap.py → ...nsible_navigator/tm_tokenize/fchainmap.py b/ansible_navigator/tm_tokenize/fchainmap.py → ...nsible_navigator/tm_tokenize/fchainmap.py
diff --git a/ansible_navigator/tm_tokenize/grammars.py → ...ansible_navigator/tm_tokenize/grammars.py b/ansible_navigator/tm_tokenize/grammars.py → ...ansible_navigator/tm_tokenize/grammars.py
diff --git a/ansible_navigator/tm_tokenize/reg.py → src/ansible_navigator/tm_tokenize/reg.py b/ansible_navigator/tm_tokenize/reg.py → src/ansible_navigator/tm_tokenize/reg.py
diff --git a/ansible_navigator/tm_tokenize/region.py → src/ansible_navigator/tm_tokenize/region.py b/ansible_navigator/tm_tokenize/region.py → src/ansible_navigator/tm_tokenize/region.py
diff --git a/ansible_navigator/tm_tokenize/rules.py → src/ansible_navigator/tm_tokenize/rules.py b/ansible_navigator/tm_tokenize/rules.py → src/ansible_navigator/tm_tokenize/rules.py
diff --git a/ansible_navigator/tm_tokenize/state.py → src/ansible_navigator/tm_tokenize/state.py b/ansible_navigator/tm_tokenize/state.py → src/ansible_navigator/tm_tokenize/state.py
diff --git a/ansible_navigator/tm_tokenize/tokenize.py → ...ansible_navigator/tm_tokenize/tokenize.py b/ansible_navigator/tm_tokenize/tokenize.py → ...ansible_navigator/tm_tokenize/tokenize.py
diff --git a/ansible_navigator/tm_tokenize/utils.py → src/ansible_navigator/tm_tokenize/utils.py b/ansible_navigator/tm_tokenize/utils.py → src/ansible_navigator/tm_tokenize/utils.py
diff --git a/ansible_navigator/ui_framework/__init__.py → ...nsible_navigator/ui_framework/__init__.py b/ansible_navigator/ui_framework/__init__.py → ...nsible_navigator/ui_framework/__init__.py
diff --git a/ansible_navigator/ui_framework/colorize.py → ...nsible_navigator/ui_framework/colorize.py b/ansible_navigator/ui_framework/colorize.py → ...nsible_navigator/ui_framework/colorize.py
diff --git a/...ble_navigator/ui_framework/curses_defs.py → ...ble_navigator/ui_framework/curses_defs.py b/...ble_navigator/ui_framework/curses_defs.py → ...ble_navigator/ui_framework/curses_defs.py
diff --git a/...e_navigator/ui_framework/curses_window.py → ...e_navigator/ui_framework/curses_window.py b/...e_navigator/ui_framework/curses_window.py → ...e_navigator/ui_framework/curses_window.py
diff --git a/...le_navigator/ui_framework/field_button.py → ...le_navigator/ui_framework/field_button.py b/...le_navigator/ui_framework/field_button.py → ...le_navigator/ui_framework/field_button.py
diff --git a/...le_navigator/ui_framework/field_checks.py → ...le_navigator/ui_framework/field_checks.py b/...le_navigator/ui_framework/field_checks.py → ...le_navigator/ui_framework/field_checks.py
diff --git a/...vigator/ui_framework/field_information.py → ...vigator/ui_framework/field_information.py b/...vigator/ui_framework/field_information.py → ...vigator/ui_framework/field_information.py
diff --git a/...le_navigator/ui_framework/field_option.py → ...le_navigator/ui_framework/field_option.py b/...le_navigator/ui_framework/field_option.py → ...le_navigator/ui_framework/field_option.py
diff --git a/...ble_navigator/ui_framework/field_radio.py → ...ble_navigator/ui_framework/field_radio.py b/...ble_navigator/ui_framework/field_radio.py → ...ble_navigator/ui_framework/field_radio.py
diff --git a/ansible_navigator/ui_framework/field_text.py → ...ible_navigator/ui_framework/field_text.py b/ansible_navigator/ui_framework/field_text.py → ...ible_navigator/ui_framework/field_text.py
diff --git a/...e_navigator/ui_framework/field_working.py → ...e_navigator/ui_framework/field_working.py b/...e_navigator/ui_framework/field_working.py → ...e_navigator/ui_framework/field_working.py
diff --git a/ansible_navigator/ui_framework/form.py → src/ansible_navigator/ui_framework/form.py b/ansible_navigator/ui_framework/form.py → src/ansible_navigator/ui_framework/form.py
diff --git a/ansible_navigator/ui_framework/form_defs.py → ...sible_navigator/ui_framework/form_defs.py b/ansible_navigator/ui_framework/form_defs.py → ...sible_navigator/ui_framework/form_defs.py
diff --git a/...gator/ui_framework/form_handler_button.py → ...gator/ui_framework/form_handler_button.py b/...gator/ui_framework/form_handler_button.py → ...gator/ui_framework/form_handler_button.py
diff --git a/.../ui_framework/form_handler_information.py → .../ui_framework/form_handler_information.py b/.../ui_framework/form_handler_information.py → .../ui_framework/form_handler_information.py
diff --git a/...ator/ui_framework/form_handler_options.py → ...ator/ui_framework/form_handler_options.py b/...ator/ui_framework/form_handler_options.py → ...ator/ui_framework/form_handler_options.py
diff --git a/...vigator/ui_framework/form_handler_text.py → ...vigator/ui_framework/form_handler_text.py b/...vigator/ui_framework/form_handler_text.py → ...vigator/ui_framework/form_handler_text.py
diff --git a/...ator/ui_framework/form_handler_working.py → ...ator/ui_framework/form_handler_working.py b/...ator/ui_framework/form_handler_working.py → ...ator/ui_framework/form_handler_working.py
diff --git a/..._navigator/ui_framework/form_presenter.py → ..._navigator/ui_framework/form_presenter.py b/..._navigator/ui_framework/form_presenter.py → ..._navigator/ui_framework/form_presenter.py
diff --git a/ansible_navigator/ui_framework/form_utils.py → ...ible_navigator/ui_framework/form_utils.py b/ansible_navigator/ui_framework/form_utils.py → ...ible_navigator/ui_framework/form_utils.py
diff --git a/...le_navigator/ui_framework/menu_builder.py → ...le_navigator/ui_framework/menu_builder.py b/...le_navigator/ui_framework/menu_builder.py → ...le_navigator/ui_framework/menu_builder.py
diff --git a/ansible_navigator/ui_framework/sentinals.py → ...sible_navigator/ui_framework/sentinals.py b/ansible_navigator/ui_framework/sentinals.py → ...sible_navigator/ui_framework/sentinals.py
diff --git a/ansible_navigator/ui_framework/ui.py → src/ansible_navigator/ui_framework/ui.py b/ansible_navigator/ui_framework/ui.py → src/ansible_navigator/ui_framework/ui.py
diff --git a/ansible_navigator/ui_framework/ui_config.py → ...sible_navigator/ui_framework/ui_config.py b/ansible_navigator/ui_framework/ui_config.py → ...sible_navigator/ui_framework/ui_config.py
diff --git a/ansible_navigator/ui_framework/utils.py → src/ansible_navigator/ui_framework/utils.py b/ansible_navigator/ui_framework/utils.py → src/ansible_navigator/ui_framework/utils.py
diff --git a/ansible_navigator/ui_framework/validators.py → ...ible_navigator/ui_framework/validators.py b/ansible_navigator/ui_framework/validators.py → ...ible_navigator/ui_framework/validators.py
diff --git a/ansible_navigator/utils.py → src/ansible_navigator/utils.py b/ansible_navigator/utils.py → src/ansible_navigator/utils.py
diff --git a/ansible_navigator/yaml.py → src/ansible_navigator/yaml.py b/ansible_navigator/yaml.py → src/ansible_navigator/yaml.py
diff --git a/tox.ini b/tox.ini
@@ -68,7 +68,7 @@ allowlist_externals = ansible-playbook
 [testenv:type]
 description = Verify static typing with MyPy under {basepython} ({envpython})
 commands =
-    mypy --txt-report ./{[base]mypy_tmp_dir} ./{[base]pkg_name} ./tests ./share
+    mypy --txt-report ./{[base]mypy_tmp_dir} ./src/{[base]pkg_name} ./tests ./share
 
 [testenv:build-docs]
 allowlist_externals =
@@ -94,7 +94,7 @@ commands =
     -a \
     -n \
     -W --keep-going \
-    -d "{toxinidir}/.tmp/.doctrees" \
+    -d "{toxinidir}/.tox/.doctrees" \
     . \
     "{envdir}/docs_out"