detquantlib 2.0.4

An internal library containing functions and classes that can be used across Quant models.

DET Quant Library

The DET Quant Library is an internal library containing functions and classes that can be used across Quant models.

Instructions

Version control

• This repository contains a version control workflow.
• The version number is specified via the version field in the pyproject.toml file.
• The version number needs to be updated with every new master commit. If the version is not updated, the GitHub workflow will fail.
• Version numbers should follow semantic versioning (i.e. X.Y.Z). That is:
  • X increments represent major, non-backward compatible updates.
  • Y increments represent minor, backward compatible functionality updates.
  • Z increments represent patch/bugfix, backward compatible updates.

Release notes

• When deemed necessary (especially in case of major updates), developers can document code changes in dedicated GitHub release notes.
• Release notes can be created via https://github.com/Dynamic-Energy-Trading/detquantlib/releases.
• In any case, all codes changes should always be properly described/documented in GitHub issues and/or pull requests.

Installing the detquantlib package in other Python projects

To install the library in another project, use the following poetry command:

poetry add git+https://github.com/Dynamic-Energy-Trading/detquantlib.git@vX.Y.Z

where vX.Y.Z should be replaced with the relevant version (e.g. v1.2.3).

Development settings

Dependency management

Project dependencies are managed by Poetry.

The project follows the standard Poetry structure:

poetrytemplate
├── pyproject.toml
├── README.md
├── src
│   └── __init__.py
└── tests
    └── __init__.py

Dependency updates

This project is executing automated dependency updates using Dependabot with GitHub actions.

Invoke development tasks

Development tasks are defined with the Invoke package.

What is Invoke?

Invoke provides a clean, high level API for running shell commands and defining/organizing task functions from a tasks.py file.

How to run development tasks?

Development tasks can be executed directly from the terminal, using the inv (or invoke) command line tool.

For guidance on the available Invoke development tasks, execute the following command in the terminal:

inv --list

Use the -h (or --help) argument for help about a particular development task. For example:

inv lint -h

CI/CD process

This project is executing CI checks using GitHub actions workflows.

The GitHub workflow defined in this project was inspired by the following preconfigured templates:

• Python package: A general workflow template for Python packages.
• Poetry action: A GitHub action for installing and configuring Poetry.

CI check: Testing

Code changes are tested with the Pytest package.

The CI check is executed with the following the development task:

inv test -c

CI check: Code formatting

Linters are used to check that the code is properly formatted:

• Isort for the imports section
• Darglint for the docstrings description
• Black for the main code
• Pymarkdown for the markdown file README.md

The CI check is executed with the following development task:

inv lint -c

If the CI check fails, execute the following command in the terminal:

inv lint

This command fixes the parts of the code that should be reformatted. Adding the -c (or --check) optional argument instructs the command to only check if parts of the code should be reformatted, without applying any actual changes.