Skip to content
Permalink
Browse files

Replace epydoc metadata with SPDX identifiers.

Most of the epydoc metadata (author, copyright, email) is duplicate in
the package's setup.py or README. These copies are more likely to get out
of date, and increase the amount of work to keep them in line.

The license information should rather be provided with an SPDX identifier,
which is more similar to what the Linux kernel and other projects, such as
pyserial, do.
  • Loading branch information...
Flameeyes committed Feb 8, 2019
1 parent 9ee1ec6 commit 6194b0f0f7d39a1b5df659b331ebb63bb94109de
@@ -1,5 +1,7 @@
#!/usr/bin/env python3
# -*- python -*-
#
# SPDX-License-Identifier: MIT

from glucometerutils import glucometer

@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common routines for data in glucometers."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013, Diego Elio Pettenò'
__license__ = 'MIT'

import datetime
import enum
import textwrap
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for Accu-Chek Mobile devices with reports mode.
Supported features:
@@ -12,11 +14,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2016, Diego Elio Pettenò'
__license__ = 'MIT'

import csv
import datetime
import glob
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for FreeStyle InsuLinx devices.
Supported features:
@@ -14,11 +16,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import collections
import datetime

@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for FreeStyle Libre devices.
Supported features:
@@ -15,11 +17,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import datetime

from glucometerutils import common
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for FreeStyle Optium devices.
Supported features:
@@ -14,11 +16,6 @@
https://flameeyes.github.io/glucometer-protocols/abbott/freestyle-optium
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2016-2017, Diego Elio Pettenò'
__license__ = 'MIT'

import datetime
import logging
import re
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for FreeStyle Precision Neo devices.
This driver may also work with FreeStyle Optium Neo devices, but it is currently
@@ -18,11 +20,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import collections
import datetime

@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for LifeScan OneTouch Ultra 2 devices.
Supported features:
@@ -11,11 +13,6 @@
Expected device path: /dev/ttyUSB0 or similar serial port device.
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013-2017, Diego Elio Pettenò'
__license__ = 'MIT'

import datetime
import re

@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for LifeScan OneTouch Ultra Easy devices.
Also supports OneTouch Ultra Mini devices (different name, same device).
@@ -13,11 +15,6 @@
Expected device path: /dev/ttyUSB0 or similar serial port device.
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2014-2018, Diego Elio Pettenò'
__license__ = 'MIT'

import binascii
import datetime
import logging
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for LifeScan OneTouch Verio (2015) and Select Plus devices.
Verio 2015 devices can be recognized by microUSB connectors.
@@ -20,11 +22,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2016-2018, Diego Elio Pettenò'
__license__ = 'MIT'

import binascii
import datetime
import logging
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for LifeScan OneTouch Verio IQ devices.
Supported features:
@@ -13,11 +15,6 @@
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2018, Diego Elio Pettenò'
__license__ = 'MIT'

import binascii
import datetime
import logging
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Driver for SD CodeFree devices by SD Biosensor.
For SD Biosensor glucometers using the serial interface.
@@ -13,12 +15,6 @@
it has to be turned on when the program asks you to.
"""


__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import binascii
import datetime
import enum
@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common exceptions for glucometerutils."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013, Diego Elio Pettenò'
__license__ = 'MIT'

class Error(Exception):
"""Base class for the errors."""

@@ -1,12 +1,9 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Utility to manage glucometers' data."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013-2017, Diego Elio Pettenò'
__license__ = 'MIT'

import argparse
import importlib
import inspect
@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Extra classes for Construct."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2018, Diego Elio Pettenò'
__license__ = 'MIT'

import datetime

import construct
@@ -1,16 +1,13 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common routines to implement the FreeStyle common protocol.
Protocol documentation available at
https://flameeyes.github.io/glucometer-protocols/abbott/shared-hid-protocol.html
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import csv
import datetime
import logging
@@ -1,11 +1,9 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common routines and base driver class for HID-based meters.
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import logging
import os

@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common utility functions for LifeScan meters."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013-2017, Diego Elio Pettenò'
__license__ = 'MIT'

from glucometerutils import exceptions


@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Support module for the LifeScan binary protocol.
A number of LifeScan devices use a semi-compatible binary protocol to talk host
@@ -7,11 +9,6 @@
This module implements an interface to send and receive these messages.
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2014-2018, Diego Elio Pettenò'
__license__ = 'MIT'

import construct

from glucometerutils import common
@@ -1,12 +1,9 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Common routines and base driver class for serial-based meters.
"""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2017, Diego Elio Pettenò'
__license__ = 'MIT'

import logging

try:
@@ -1,4 +1,6 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT

import sys

@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Add the top-level module to the PYTHONPATH."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2018, Diego Elio Pettenò'
__license__ = 'MIT'

import os
import sys

@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Tests for the common routines."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2013-2018, Diego Elio Pettenò'
__license__ = 'MIT'

# pylint: disable=protected-access,missing-docstring

import datetime
@@ -1,11 +1,8 @@
# -*- coding: utf-8 -*-
#
# SPDX-License-Identifier: MIT
"""Tests for the common routines."""

__author__ = 'Diego Elio Pettenò'
__email__ = 'flameeyes@flameeyes.com'
__copyright__ = 'Copyright © 2018, Diego Elio Pettenò'
__license__ = 'MIT'

# pylint: disable=protected-access,missing-docstring

import datetime

0 comments on commit 6194b0f

Please sign in to comment.
You can’t perform that action at this time.