Software Systems Laboratory Template Python Project

A template Python project for bootstrapping tool development

Table of Contents

• Software Systems Laboratory Template Python Project
  • Table of Contents
  • About
  • Developer Tooling
    • Operating System
    • Shell Software
    • Python Software
  • How To Use
  • Changes To Make To Your Project

About

The Software Systems Laboratory (SSL) Template Python Project is a git repository that can be cloned and modified to bootstrap development of tools for the greater SSL Metrics project. It can also be modified by outside teams or individuals for usage of their own personal projects.

This project is licensed under the BSD-3-Clause. See the LICENSE for more information.

Developer Tooling

To maximize the utility of this project and the greater SSL Metrics project, the following software packages are required:

Operating System

All tools developed for the greater SSL Metrics project must target Mac OS and Linux. SSL Metrics software is not supported or recommended to run on Windows but can be modified to do so at your own risk.

It is recomendded to develop on Mac OS or Linux. However, if you are on a Windows machine, you can use WSL to develop as well.

Shell Software

• git
• jq
• wc

Python Software

The software listed in this section is meant for developing tools

All listed Python software assumes that you have downloaded and installed Python 3.9.6 or greater.

• black
• build
• isort
• pylint

You can install all of the Python software with this one-liner:

pip install --upgrade black build isort pip pylint

How To Use

It is recomended to create a new repository with GitHub referencing this template and then cloning the new repository.

Changes To Make To Your Project

1. Change the name of the package folder from ssl_metrics_MODULE_NAME to your packages name
2. Fix all TODOs