Readme

Core library for use in all projects (i.e. standardized logging, command line interface, etc.)

Getting Started

To get started using this module, make sure you have access to the Elevaso GitLab PyPi Registry.

For easy access, you can update your local .pypirc file, typically found in the home directory, with the following:

[global]
extra-index-url = https://__token__:{GITLAB_TOKEN}@gitlab.com/api/v4/groups/81835940/-/packages/pypi/simple # gitleaks:allow

Replace {GITLAB_TOKEN} with your actual GitLab Personal Access Token.

Next, run an install and/or upgrade pip install --upgrade <project_name>.

You can now import the library into your project by adding the following to your .py file.

import <project_name>

Note

Replace <project_name> with Elevaso-Spine in the pip install and import code above.

Advanced Usage

Versioning & Change Log

This project uses the Semantic Versioning, which consists of MAJOR.MINOR.PATCH, and follows the best practices of change log usage from KeepAChangeLog.

A CHANGELOG file tracks all the changes by version in friendly format, with the format of:

1 # Change Log
2
3 ## <MAJOR>.<MINOR>.<PATCH> - MONTH DD, YYYY
4     * <Type>
5         * <Description>
6             * <module>

Where the following placeholders are used as:

Type

Description

type
Type of change, with acceptable values of

  • Added: New features

  • Changed: Updates to existing features

  • Deprecated: Soon-to-be removed features

  • Removed: Now removed features

  • Fixed: Bug fixes

  • Security: Vulnerability fixes

module

List of file(s) the change applies to

description

Description of the change made

Changes are displayed in descending order (most recent first), with an UNRELEASED section at the very top for changes that are pending.

Requirements

Below is a list of all external python libraries that are used in this project, which can also be found in requirements.txt located at the root of the project. Every attempt has been made to avoid external dependencies to avoid compability and build issues, however, the external libraries used have been reviewed exhaustively.

requirements.txt

python-dateutil