Malcolm3Utils

Documentation: https://malcolm-3.github.io/malcolm3utils

Source Code: https://github.com/malcolm-3/malcolm3utils

PyPI: https://pypi.org/project/malcolm3utils/

Collection of Utility Scripts and Packages

Installation

pip install malcolm3utils

Usage

This package provides the following command line tools

• touch_latest
  • This touches a marker file with the timestamp of the most recently changed file under the specified directories
• getcol
  • A tool for extracting columns of data by column header name or column id
• merge
  • A version of the join command that doesn't require pre-sorting
• filter
  • Filter csv files using expressions containing the column headers

Development

• Clone this repository
• Requirements:
  • Poetry
  • Python 3.9+
• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the python-package-cookiecutter template.