dantali0n / radloggerpy

Radiation monitoring solution for a variety of instrument types.

RadLoggerPy

RadLoggerPy is a radiation logging and monitoring solution, primarily, designed to be used with background radiation measuring devices.

• Free software: Apache license
• Source: https://github.com/Dantali0n/RadLoggerPy
• Documentation: https://root.pages.dantalion.nl/radloggerpy/
• Bugs: https://github.com/Dantali0n/RadLoggerPy/issues
• CI pipeline: https://gitlab.dantalion.nl/root/radloggerpy/-/pipelines
• Code coverage: https://codecov.io/gh/Dantali0n/radloggerpy/tree/master/radloggerpy

radloggerpy's Issues

Refactor database object methods to reduce duplicate code

Many of the database objects methods share a lot of code that could potentially be reduced.

    def find(session, reference, allow_multiple=True):
        reference._build_object()

        """Only look for serial devices"""
        reference.m_device.interface = DeviceInterfaces.SERIAL

        base_filters = reference._filter(reference.m_device)

        """Check if reference is base or child type when setting filters"""
        if hasattr(reference, 'm_serial_device'):
            filters = reference._filter(reference.m_serial_device)
        else:
            filters = {}

        query = session.query(Device).filter_by(**base_filters)\
            .join(SerialDevice).filter_by(**filters)

    def delete(session, reference, allow_multiple=False):
        reference._build_object()

        filters = reference._filter(reference.m_device)
        query = session.query(Device).filter_by(**filters)

Test using gitlab releases for automatic releasenotes

Gather releasenotes from gitlab releases and use squash merge strategy

Hacking rule to prevent raising Warning exceptions

Exceptions that inherit from Warning should never be raised they should be logged using oslo log. Create a hacking rule to catch these programming mistakes.

Create reproducible build setup using pipenv.lock file at the time of a release

Release dependency versions should be set in stone at the time of release

Change current DeviceTypes into DeviceInterfaces

DeviceTypes in terms of radiological devices is quite vague and does not clearly indicate that it implies the communication interface for a device. Instead DeviceInterfaces would be a better indicator which would than subsequently allow DeviceTypes to be used more effectively.

For instance, DeviceTypes could be used to distinguish between geiger counters, proportional counters, scintillation devices or semiconductor based counters. This distinction is quite important as it allows to associate certain types of radiation measurements with devices.

As an example, Geiger counters can not accurately measure absorbed dose as they do not proportionally measure the energy of each count (event). While a dosimeter will sometimes only measure effective and or equivalent dose and not have any way to report absorbed dose.

Publish documentation to gitlab-pages

Requires certbot configuration for wildcard dns, investigate dns provider plugin support.

[localization] locale generation should verify current pot file

When CI generates the pot files it should verify that the currently commited pot file matches what is generated by the CI.

IMPLEMENTATION_CHOICES can't use dynamic device discovery due to circular imports

The IMPLEMENTATION_CHOICES variable needs to be fully evaluated statically as it is used to fill possible values in database table columns. However, due to circular imports the DeviceManager its dynamic discovery features can't be used in this static context.

Hide StateMachine to external Device users

The Device abstract class inherits StateMachine which allows external access to the transition method. This is undesirable, instead Device should keep an instance of StateMachine as internal object and only expose get_state.

[localization] Gettext should notify users about localization files and if they are missing

Also some debug info about were gettext has looked to try and find them. Finally some option to add an additional path through oslo.config

The warning should take into consideration the configured locale especially.

[localization] Implement the use of sphinx-intl to provide internationalized documentation

Use and implement the https://www.sphinx-doc.org/en/master/usage/advanced/intl.html project such that our readthedocs documentation can be accessed in different languages.

Design and implement PoC for dataflow between devices and endpoints

Consider mechanisms such as zero copy, threads, data locality, lockless queues and overhead of synchronization paradigms such as conditions and mutexes.

Automated check to ensure requirements files are up to date with lower-constraints.txt

Manually changing both requirements files and adjusting lower-constraints.txt is error prone. This process should be automated such that any discrepancy raises an error in CI/CD pipeline.

Update readme badge with Twitter to mastodon

No more twitter to contact me

Publish documentation on readthedocs

Storage location of SQLite database file should be agnostic to working directory

Currently the placement and location of the SQLite database file is depending upon working directory of the user, this is very error prone and unsuitable for daemon like applications.

Instead, the placement of the SQLite database should default to a subfolder in the user directory unless it is specified at an alternative location in the configuration files.

Centralize fields and attribute variables across device CLI

The device CLI has many duplicates of the fields tuple and similarly reuses the same tuple of attributes often. These variables could be part of base classes similar to the pattern used for the arguments property in combination with the _arguments variable.

class Example(metaclass=abc.ABCMeta):
    """Arguments property is extensible by child classes"""

    _arguments = None

    @property
    def arguments(self):
        if self._arguments is None:
            self._arguments = dict()
            self._arguments.update({
                '--id': Argument(
                    '-i', help="Example argument attribute",
                    type=int)
            })
        return self._arguments

Silent mode to disable any unwanted output

Sometimes it might be desired to execute a command and store the results in a file. In this case it is undesirable to output any additional messages as these would globber the file being generated.

A special silent mode needs to be added that will disable any unwanted output. The silent mode should be enabled by default when the -f parameter is supplied in radloggercli

• Implement silent mode
• Enable silent mode when -f is set

Use of TypeVar(... bound=Example) vs Type[Example]

From the Python documentation it is clear that using TypeVar(... bound=Example) will constraint the type to a subclass of Example.

What is unclear is how:

_U = TypeVar('_U', bound=Example)
Type[_U]

Is different from:

Type[Example]

Is there any reason to prefer one over the other? and what are the consequences of these differences?

Publish package to pypi

Cliff CLI should log any uncaught exceptions

Make this somewhat smart where it uses LOG.error for error exceptions and LOG.warning if the exception inherits Warning.

Only CLI should be allowed to actually raise a Warning.

Setuptools_scm marks builds as dev builds when releasing new version

Convert to pyproject.toml and use VERSION file with __version__ global

Investigate the use of Marshmallow as replacement for database object interface

https://marshmallow.readthedocs.io/en/stable/

Design endpoint interface class and endpoint topic manager / broker

Design how the interface class will look and operate for the endpoints as well as the topic and message broker receiving the events for these endpoints.