Restructure to src layout

ISISComputingGroup · Nov 16, 2024 · e4c9967 · e4c9967
1 parent 089c958
commit e4c9967
Show file tree

Hide file tree

Showing 64 changed files with 158 additions and 70 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,74 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
 *.py[cod]
-*.swp
-*~
-*.egg-info
-.idea/
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
 docs/_build/
-docs/doxygen/
-.vs/
-
-# Installed Python files
-Doc/
-DLLs/
-EPICS_UTILS
-LICENSE.txt
-NEWS.txt
-Scripts/
-Tools/
-include/
-libs/
-tcl/
-share/
-README.txt
-python.*
-python27.*
-pythonw.*
-VERSION.txt
-BUILD_NUMBER.txt
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
 ipython_config.py
 
-# Installed Python 3 files
-Logs/
-etc/
-man/
-*.dll
-*.pdb
-*.exe
-*._pth
-qt.conf
-
-# Ignore our own scripts
-# don't use  genie_python*  as it also matches directory in site-packages
-/genie_python.bat
-/genie_python3.bat
-/genie_python_main.bat
-/genie_python.ico
-/genie_python_simulate.bat
-/get_isis_ip.bat
-/add_genie_python_to_mantid.bat
-
-# Test files
-**/test-reports
-
-# Ignore Lib except genie_python source
-# Needs to be done this slightly convoluted way as you cannot
-# unexclude a directory if the parent directory is excluded
-Lib/*
-!Lib/site-packages/
-Lib/site-packages/*
-!Lib/site-packages/genie_python/
-
-*.zip
-package_builder/get-pip.py
-
-package_builder/python_deps/*
-package_builder/smslib/build/*
-package_builder/smslib/sms.c
-package_builder/CaChannel-3.1.2.tar.gz
-*.log
-*.msi
-package_builder/build-genie-python/
-package_builder/epics-base/
-package_builder/genie_python
-package_builder/genie_python.tar.gz
-package_builder/genie_python.tgz
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
diff --git a/Lib/site-packages/genie_python/.pylintrc → src/genie_python/.pylintrc b/Lib/site-packages/genie_python/.pylintrc → src/genie_python/.pylintrc
diff --git a/Lib/site-packages/genie_python/__init__.py → src/genie_python/__init__.py b/Lib/site-packages/genie_python/__init__.py → src/genie_python/__init__.py
diff --git a/...site-packages/genie_python/block_names.py → src/genie_python/block_names.py b/...site-packages/genie_python/block_names.py → src/genie_python/block_names.py
diff --git a/...genie_python/channel_access_exceptions.py → ...genie_python/channel_access_exceptions.py b/...genie_python/channel_access_exceptions.py → ...genie_python/channel_access_exceptions.py
diff --git a/Lib/site-packages/genie_python/genie.py → src/genie_python/genie.py b/Lib/site-packages/genie_python/genie.py → src/genie_python/genie.py
diff --git a/...e-packages/genie_python/genie_advanced.py → src/genie_python/genie_advanced.py b/...e-packages/genie_python/genie_advanced.py → src/genie_python/genie_advanced.py
diff --git a/...ite-packages/genie_python/genie_alerts.py → src/genie_python/genie_alerts.py b/...ite-packages/genie_python/genie_alerts.py → src/genie_python/genie_alerts.py
diff --git a/...-packages/genie_python/genie_api_setup.py → src/genie_python/genie_api_setup.py b/...-packages/genie_python/genie_api_setup.py → src/genie_python/genie_api_setup.py
diff --git a/...ackages/genie_python/genie_blockserver.py → src/genie_python/genie_blockserver.py b/...ackages/genie_python/genie_blockserver.py → src/genie_python/genie_blockserver.py
diff --git a/...s/genie_python/genie_cachannel_wrapper.py → src/genie_python/genie_cachannel_wrapper.py b/...s/genie_python/genie_cachannel_wrapper.py → src/genie_python/genie_cachannel_wrapper.py
diff --git a/...ckages/genie_python/genie_change_cache.py → src/genie_python/genie_change_cache.py b/...ckages/genie_python/genie_change_cache.py → src/genie_python/genie_change_cache.py
diff --git a/Lib/site-packages/genie_python/genie_dae.py → src/genie_python/genie_dae.py b/Lib/site-packages/genie_python/genie_dae.py → src/genie_python/genie_dae.py
diff --git a/...-packages/genie_python/genie_epics_api.py → src/genie_python/genie_epics_api.py b/...-packages/genie_python/genie_epics_api.py → src/genie_python/genie_epics_api.py
diff --git a/...s/genie_python/genie_experimental_data.py → src/genie_python/genie_experimental_data.py b/...s/genie_python/genie_experimental_data.py → src/genie_python/genie_experimental_data.py
diff --git a/...te-packages/genie_python/genie_logging.py → src/genie_python/genie_logging.py b/...te-packages/genie_python/genie_logging.py → src/genie_python/genie_logging.py
diff --git a/...ackages/genie_python/genie_p4p_wrapper.py → src/genie_python/genie_p4p_wrapper.py b/...ackages/genie_python/genie_p4p_wrapper.py → src/genie_python/genie_p4p_wrapper.py
diff --git a/Lib/site-packages/genie_python/genie_plot.py → src/genie_python/genie_plot.py b/Lib/site-packages/genie_python/genie_plot.py → src/genie_python/genie_plot.py
diff --git a/...enie_python/genie_pre_post_cmd_manager.py → ...enie_python/genie_pre_post_cmd_manager.py b/...enie_python/genie_pre_post_cmd_manager.py → ...enie_python/genie_pre_post_cmd_manager.py
diff --git a/...ie_python/genie_pv_connection_protocol.py → ...ie_python/genie_pv_connection_protocol.py b/...ie_python/genie_pv_connection_protocol.py → ...ie_python/genie_pv_connection_protocol.py
diff --git a/...ckages/genie_python/genie_scisoft_plot.py → src/genie_python/genie_scisoft_plot.py b/...ckages/genie_python/genie_scisoft_plot.py → src/genie_python/genie_scisoft_plot.py
diff --git a/...ages/genie_python/genie_script_checker.py → src/genie_python/genie_script_checker.py b/...ages/genie_python/genie_script_checker.py → src/genie_python/genie_script_checker.py
diff --git a/...es/genie_python/genie_script_generator.py → src/genie_python/genie_script_generator.py b/...es/genie_python/genie_script_generator.py → src/genie_python/genie_script_generator.py
diff --git a/...e-packages/genie_python/genie_simulate.py → src/genie_python/genie_simulate.py b/...e-packages/genie_python/genie_simulate.py → src/genie_python/genie_simulate.py
diff --git a/...kages/genie_python/genie_simulate_impl.py → src/genie_python/genie_simulate_impl.py b/...kages/genie_python/genie_simulate_impl.py → src/genie_python/genie_simulate_impl.py
diff --git a/...te-packages/genie_python/genie_startup.py → src/genie_python/genie_startup.py b/...te-packages/genie_python/genie_startup.py → src/genie_python/genie_startup.py
diff --git a/...ges/genie_python/genie_toggle_settings.py → src/genie_python/genie_toggle_settings.py b/...ges/genie_python/genie_toggle_settings.py → src/genie_python/genie_toggle_settings.py
diff --git a/...kages/genie_python/genie_wait_for_move.py → src/genie_python/genie_wait_for_move.py b/...kages/genie_python/genie_wait_for_move.py → src/genie_python/genie_wait_for_move.py
diff --git a/...te-packages/genie_python/genie_waitfor.py → src/genie_python/genie_waitfor.py b/...te-packages/genie_python/genie_waitfor.py → src/genie_python/genie_waitfor.py
diff --git a/...nie_python/matplotlib_backend/__init__.py → ...nie_python/matplotlib_backend/__init__.py b/...nie_python/matplotlib_backend/__init__.py → ...nie_python/matplotlib_backend/__init__.py
diff --git a/...plotlib_backend/ibex_websocket_backend.py → ...plotlib_backend/ibex_websocket_backend.py b/...plotlib_backend/ibex_websocket_backend.py → ...plotlib_backend/ibex_websocket_backend.py
diff --git a/...s/genie_python/mysql_abstraction_layer.py → src/genie_python/mysql_abstraction_layer.py b/...s/genie_python/mysql_abstraction_layer.py → src/genie_python/mysql_abstraction_layer.py
diff --git a/Lib/site-packages/genie_python/run_tests.py → src/genie_python/run_tests.py b/Lib/site-packages/genie_python/run_tests.py → src/genie_python/run_tests.py
diff --git a/...thon/scanning_instrument_pylint_plugin.py → ...thon/scanning_instrument_pylint_plugin.py b/...thon/scanning_instrument_pylint_plugin.py → ...thon/scanning_instrument_pylint_plugin.py
diff --git a/...ie_python/typings/CaChannel/CaChannel.pyi → ...ie_python/typings/CaChannel/CaChannel.pyi b/...ie_python/typings/CaChannel/CaChannel.pyi → ...ie_python/typings/CaChannel/CaChannel.pyi
diff --git a/...nie_python/typings/CaChannel/__init__.pyi → ...nie_python/typings/CaChannel/__init__.pyi b/...nie_python/typings/CaChannel/__init__.pyi → ...nie_python/typings/CaChannel/__init__.pyi
diff --git a/...nie_python/typings/CaChannel/_version.pyi → ...nie_python/typings/CaChannel/_version.pyi b/...nie_python/typings/CaChannel/_version.pyi → ...nie_python/typings/CaChannel/_version.pyi
diff --git a/...ges/genie_python/typings/CaChannel/ca.pyi → src/genie_python/typings/CaChannel/ca.pyi b/...ges/genie_python/typings/CaChannel/ca.pyi → src/genie_python/typings/CaChannel/ca.pyi
diff --git a/Lib/site-packages/genie_python/utilities.py → src/genie_python/utilities.py b/Lib/site-packages/genie_python/utilities.py → src/genie_python/utilities.py
diff --git a/Lib/site-packages/genie_python/version.py → src/genie_python/version.py b/Lib/site-packages/genie_python/version.py → src/genie_python/version.py
diff --git a/...ges/genie_python/test_modules/__init__.py → tests/__init__.py b/...ges/genie_python/test_modules/__init__.py → tests/__init__.py
diff --git a/...dules/py3_test_genie_experimental_data.py → tests/py3_test_genie_experimental_data.py b/...dules/py3_test_genie_experimental_data.py → tests/py3_test_genie_experimental_data.py
diff --git a/...e_python/test_modules/test_block_names.py → tests/test_block_names.py b/...e_python/test_modules/test_block_names.py → tests/test_block_names.py
diff --git a/...s/genie_python/test_modules/test_genie.py → tests/test_genie.py b/...s/genie_python/test_modules/test_genie.py → tests/test_genie.py
diff --git a/..._python/test_modules/test_genie_alerts.py → tests/test_genie_alerts.py b/..._python/test_modules/test_genie_alerts.py → tests/test_genie_alerts.py
diff --git a/...thon/test_modules/test_genie_api_setup.py → tests/test_genie_api_setup.py b/...thon/test_modules/test_genie_api_setup.py → tests/test_genie_api_setup.py
diff --git a/...t_modules/test_genie_blockserver_tests.py → tests/test_genie_blockserver_tests.py b/...t_modules/test_genie_blockserver_tests.py → tests/test_genie_blockserver_tests.py
diff --git a/...n/test_modules/test_genie_change_cache.py → tests/test_genie_change_cache.py b/...n/test_modules/test_genie_change_cache.py → tests/test_genie_change_cache.py
diff --git a/...nie_python/test_modules/test_genie_dae.py → tests/test_genie_dae.py b/...nie_python/test_modules/test_genie_dae.py → tests/test_genie_dae.py
diff --git a/...thon/test_modules/test_genie_epics_api.py → tests/test_genie_epics_api.py b/...thon/test_modules/test_genie_epics_api.py → tests/test_genie_epics_api.py
diff --git a/.../test_modules/test_genie_wait_for_move.py → tests/test_genie_wait_for_move.py b/.../test_modules/test_genie_wait_for_move.py → tests/test_genie_wait_for_move.py
diff --git a/...python/test_modules/test_genie_waitfor.py → tests/test_genie_waitfor.py b/...python/test_modules/test_genie_waitfor.py → tests/test_genie_waitfor.py
diff --git a/...n/test_modules/test_matplotlib_backend.py → tests/test_matplotlib_backend.py b/...n/test_modules/test_matplotlib_backend.py → tests/test_matplotlib_backend.py
diff --git a/...t_modules/test_mysql_abstraction_layer.py → tests/test_mysql_abstraction_layer.py b/...t_modules/test_mysql_abstraction_layer.py → tests/test_mysql_abstraction_layer.py
diff --git a/...ython/test_modules/test_script_checker.py → tests/test_script_checker.py b/...ython/test_modules/test_script_checker.py → tests/test_script_checker.py
diff --git a/...hon/test_modules/test_script_generator.py → tests/test_script_generator.py b/...hon/test_modules/test_script_generator.py → tests/test_script_generator.py
diff --git a/...python/test_modules/test_scripts/error.py → tests/test_scripts/error.py b/...python/test_modules/test_scripts/error.py → tests/test_scripts/error.py
diff --git a/.../test_scripts/error_for_script_checker.py → .../test_scripts/error_for_script_checker.py b/.../test_scripts/error_for_script_checker.py → .../test_scripts/error_for_script_checker.py
diff --git a/...python/test_modules/test_scripts/valid.py → tests/test_scripts/valid.py b/...python/test_modules/test_scripts/valid.py → tests/test_scripts/valid.py
diff --git a/...st_modules/test_scripts/valid_python_2.py → tests/test_scripts/valid_python_2.py b/...st_modules/test_scripts/valid_python_2.py → tests/test_scripts/valid_python_2.py
diff --git a/...t_modules/test_scripts/valid_to_import.py → tests/test_scripts/valid_to_import.py b/...t_modules/test_scripts/valid_to_import.py → tests/test_scripts/valid_to_import.py
diff --git a/...ie_python/test_modules/test_simulation.py → tests/test_simulation.py b/...ie_python/test_modules/test_simulation.py → tests/test_simulation.py
diff --git a/...nie_python/test_modules/test_utilities.py → tests/test_utilities.py b/...nie_python/test_modules/test_utilities.py → tests/test_utilities.py
diff --git a/...dules/test_utils_with_unicode_literals.py → tests/test_utils_with_unicode_literals.py b/...dules/test_utils_with_unicode_literals.py → tests/test_utils_with_unicode_literals.py