gets code from old repo

.dae-devops/Makefile

@@ -0,0 +1,72 @@
+# ********** Please don't edit this file!
+# ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+# ********** For repository_name echolocator
+
+# ---------------------------------------------------------------------
+# These make targets are designed to be called from the command line and from .gitlab-ci.yml.
+# ---------------------------------------------------------------------
+
+# I put the package_pip artifacts int this place for now until I can use the corporate internal pipserver.
+# Maybe /dls_sw/work/python3/RHEL7-x86_64/distributions would be a better place?
+PIP_FIND_LINKS = /dls_sw/apps/bxflow/artifacts
+
+# I got these from https://gitlab.diamond.ac.uk/controls/reports/ci_templates/-/blob/master/defaults.yml.
+# Directory where docs are published.
+DOCS_PUBLISH_ROOT = /dls/cs-www/reports/gitlab-ci/echolocator
+
+# ---------------------------------------------------------------------
+# These are called from the default before_script in the gitlab CI.
+# That meants it is normally called before any other job.
+# It installs things not covered by pyproject.toml.
+
+prepare_git_dependencies:
+	chmod a+x .dae-devops/prepare_git_dependencies.sh
+	.dae-devops/prepare_git_dependencies.sh
+
+# ---------------------------------------------------------------------
+# The validate stage makes sure code is ready to package and release.
+
+validate: \
+	validate_pre_commit \
+	validate_mypy \
+	validate_pytest
+	echo "validation complete"
+
+validate_pre_commit: 
+	tox -q -e pre-commit
+
+validate_mypy: 
+	tox -q -e mypy
+
+validate_pytest: 
+	tox -q -e pytest
+
+validate_docs: 
+	tox -q -e docs
+
+# ---------------------------------------------------------------------
+# The pip state packages and publishes for pip.
+
+package: \
+	package_pip
+
+package_pip:
+	pip install pipx twine
+	pipx run build
+
+# ---------------------------------------------------------------------
+# The publish stage publishes things which have already been built or packaged.
+
+publish: \
+	publish_pip \
+	publish_docs
+
+publish_pip:
+	cp -v -p dist/*.whl $(PIP_FIND_LINKS)
+
+publish_docs:
+	mkdir -p $(DOCS_PUBLISH_ROOT)
+	cp -r build/html/* $(DOCS_PUBLISH_ROOT)
+
+
+# dae_devops_fingerprint 9fe30eea1b281488db7e7f559ccf11fd

.dae-devops/docs/conventions.rst

@@ -0,0 +1,34 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+Naming conventions
+=======================================================================
+
+Here are the naming conventions used within the source code.
+
+variables
+    lowercase, underscores
+
+constants
+    uppercase, underscores
+
+classes
+    camel case
+
+class methods
+    lowercase, underscores
+
+imports
+    require fully qualified package name (import <package> does nothing)
+
+    exception: top-level packages __init__.py will have __version__ defined in them
+
+python packages
+    lowercase, underscores
+
+repository
+    lowercase, hyphens
+
+
+.. # dae_devops_fingerprint acfc12550a704c2bae356c671aed9664

.dae-devops/docs/developing.rst

@@ -0,0 +1,39 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+Developing
+=======================================================================
+
+If you plan to make change to the code in this repository, you can use the steps below.
+
+Clone the repository::
+
+    $ git clone https://gitlab.diamond.ac.uk/xchem/echolocator.git
+
+It is recommended that you install into a virtual environment so this
+installation will not interfere with any existing Python software.
+Make sure to have at least python version 3.8 then::
+
+    $ python3 -m venv /scratch/$USER/myvenv
+    $ source /scratch/$USER/myvenv/bin/activate
+    $ pip install --upgrade pip
+
+Install the package in edit mode which will also install all its dependencies::
+
+    $ cd echolocator
+    $ export PIP_FIND_LINKS=/dls_sw/apps/bxflow/artifacts
+    $ pip install -e .[dev]
+
+Now you may begin modifying the code.
+
+|
+
+If you plan to modify the docs, you will need to::
+
+    $ pip install -e .[docs]
+
+    
+
+
+.. # dae_devops_fingerprint 5e0aaf283342a2eb98b29fa132e40755

.dae-devops/docs/devops.rst

@@ -0,0 +1,46 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+Devops
+=======================================================================
+
+There exists a a configuration file called ``.dae-devops/project.yaml``.
+
+This file defines the project information needed for CI/CD.
+
+It is parsed by the ``dae_devops.force`` command which creates these files:
+
+- pyproject.toml
+- .gitlab-ci.yml
+- .dae-devops/Makefile
+- .dae-devops/docs/*
+
+Local CI/CD execution
+-----------------------------------------------------------------------
+
+All the CI/CD ops which are run by the git server can be run at the command line.
+
+Running these ops before pushing to the git server can make the turnaround quicker to fix things.
+
+Follow the steps in the Developing section.  Then you can run the following commands.
+
+Validation of the code::
+
+    $ make -f .dae-devops/Makefile validate_pre_commit
+    $ make -f .dae-devops/Makefile validate_mypy
+    $ make -f .dae-devops/Makefile validate_pytest
+    $ make -f .dae-devops/Makefile validate_docs
+
+Packaging:: 
+
+    $ make -f .dae-devops/Makefile package_pip
+
+Publishing::
+
+    $ make -f .dae-devops/Makefile publish_pip
+    $ make -f .dae-devops/Makefile publish_docs
+    
+
+
+.. # dae_devops_fingerprint b6eefa8217e4dc4f474235991d4a5ba7

.dae-devops/docs/docs_structure.rst

@@ -0,0 +1,24 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+About the documentation
+-----------------------
+
+  :material-regular:`format_quote;2em`
+
+  The Grand Unified Theory of Documentation
+
+  -- David Laing
+
+There is a secret that needs to be understood in order to write good software
+documentation: there isn't one thing called *documentation*, there are four.
+
+They are: *tutorials*, *how-to guides*, *technical reference* and *explanation*.
+They represent four different purposes or functions, and require four different
+approaches to their creation. Understanding the implications of this will help
+improve most documentation - often immensely.
+
+`More information on this topic. <https://documentation.divio.com>`_
+
+.. # dae_devops_fingerprint e18335e3651840ab0035e2cc1d1132ea

.dae-devops/docs/installing.rst

@@ -0,0 +1,43 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+Installing
+=======================================================================
+
+
+You will need python 3.8 or later. 
+
+On a Diamond Light Source internal computer, you can achieve Python 3.8 by::
+
+    $ module load python/3.8
+
+You can check your version of python by typing into a terminal::
+
+    $ python3 --version
+
+It is recommended that you install into a virtual environment so this
+installation will not interfere with any existing Python software::
+
+    $ python3 -m venv /scratch/$USER/myvenv
+    $ source /scratch/$USER/myvenv/bin/activate
+    $ pip install --upgrade pip
+
+
+You can now use ``pip`` to install the library and its dependencies::
+
+    $ export PIP_FIND_LINKS=/dls_sw/apps/bxflow/artifacts
+    $ python3 -m pip install echolocator
+
+If you require a feature that is not currently released you can also install
+from git::
+
+    $ python3 -m pip install git+https://gitlab.diamond.ac.uk/xchem/echolocator.git
+
+The library should now be installed and the commandline interface on your path.
+You can check the version that has been installed by typing::
+
+    $ echolocator --version
+    $ echolocator --version-json
+
+.. # dae_devops_fingerprint 903b31cf688e078d4db83026cfdc7061

.dae-devops/docs/testing.rst

@@ -0,0 +1,38 @@
+.. # ********** Please don't edit this file!
+.. # ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+.. # ********** For repository_name echolocator
+
+Testing
+=======================================================================
+
+The package uses pytest for unit testing.
+
+If you want to run the tests, first get a copy of the code per the instructions in the Developing section.
+
+Then you can run all tests by::
+
+    $ pytest
+
+Or this, which is the command used by the CI runner.
+
+    $ make -f .dae-devops/Makefile validate_pytest
+
+To run a single test you can do::
+
+    $ pytest tests/the_test_you_want.py
+
+If you want to see more output of the test while it's running you can do:
+
+    $ pytest -sv -ra --tb=line tests/the_test_you_want.py
+
+Each test will write files into its own directory::
+
+    /tmp/echolocator/tests/....
+
+The tests clear their directory when they start, but not when they finish.
+This allows peeking in there to see what's been written by the test.
+
+
+
+
+.. # dae_devops_fingerprint a9541d30f1759f15f8319a09442ffd7c

.dae-devops/prepare_git_dependencies.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# ********** Please don't edit this file!
+# ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+# ********** For repository_name echolocator
+
+me=${BASH_SOURCE}
+echo "${me}: installing 0 dependencies for repository_name echolocator"
+
+function __install {
+    echo ${me}: "$@"
+    "$@"
+}
+
+
+# dae_devops_fingerprint 8024a3374581bfef1e1262baaca81f98

.dae-devops/project.yaml

@@ -0,0 +1,19 @@
+# Primary information needed for devops.
+primary:
+    repository_name: echolocator
+    package_name: echolocator_lib
+    one_line_description: "XChem GUI for manually targeting drop points for the Echo dispenser."
+    author:
+        name: David Erb
+        email: david.erb@diamond.ac.uk
+    project_urls:
+        GitLab: https://gitlab.diamond.ac.uk/xchem
+    project_scripts:
+        echolocator: "echolocator_lib.__main__:main"
+        echolocator.cli: "echolocator_cli.main:main"
+    dependencies:
+        - type: pypi
+          list:
+              - dls_servbase
+              - dls_mainiac
+              - dls_utilpack

.devcontainer/Dockerfile

@@ -0,0 +1,43 @@
+# ********** Please don't edit this file!
+# ********** It has been generated automatically by dae_devops version 0.4.1.dev0+g5d50877.d20230202.
+# ********** For repository_name echolocator
+
+# This file is for use as a devcontainer and a runtime container
+#
+# The devcontainer should use the build target and run as root with podman
+# or docker with user namespaces.
+#
+FROM python:3.11 as build
+
+ARG PIP_OPTIONS
+
+# Add any system dependencies for the developer/build environment here e.g.
+# RUN apt-get update && apt-get upgrade -y && \
+#     apt-get install -y --no-install-recommends \
+#     desired-packages \
+#     && rm -rf /var/lib/apt/lists/*
+
+# set up a virtual environment and put it in PATH
+RUN python -m venv /venv
+ENV PATH=/venv/bin:$PATH
+
+# Copy any required context for the pip install over
+COPY . /context
+WORKDIR /context
+
+# install python package into /venv
+RUN pip install ${PIP_OPTIONS}
+
+FROM python:3.11-slim as runtime
+
+# Add apt-get system dependecies for runtime here if needed
+
+# copy the virtual environment from the build stage and put it in PATH
+COPY --from=build /venv/ /venv/
+ENV PATH=/venv/bin:$PATH
+
+# change this entrypoint if it is not the same as the repo
+ENTRYPOINT ["echolocator"]
+CMD ["--version"]
+
+# dae_devops_fingerprint dcc56c6c4e5e6290a064eea1f6529c93