📚 Table of Contents

• About
• Description
• Supported Platforms
• Core Features
• Extended Documentation
• Usage
  • Pre-Requisites
  • Installation
• Development
  • Pre-Requisites
  • Setup
• Contribution
• Legalities
  • License

📖 About

🧾 Description

"With a lack of hardware, why not optimize your workflow?"

QLogicae Logis is an opinionated, multi-platform, multi-project, software development tool, as a CLI, written in Python3.

• Opinionated - For software development contributions, regardless of programming language and integrated tools of choice.

• Multi-platform - Maximizing usability, to develop software projects, across multiple operating systems.

• Software Automation - Implemented via user-defined CI/CD-like workflow YAML files. Notable major operations include: workflow macros programming, and filesystem template application across multiple projects.

• Python3 - The main project programming language of choice, with the aim to ease development time, learning curve, ease of collaboration, and multi-platform usage stability. Having said that, if it works, it works - that's what matters.

ADVICE: To get things straight, this tool is best suited for orchestrating multiple projects with a shared deliverable. Developers can still utilize its features for relatively small, single-repository projects. Having said that, please do review your own project requirements.

⚙️ Core Features

More can be added, eventually. What this project offers now to its users (and contributors) are as follows:

• CI/CD Workflow Implementations via YAML Files

• Filesystem Templates

• Workflow Macros Programming

• 3rd-Party Plugin API

• And more to come!

To know more, check out the extended documentation.

🧑‍💻 Usage

📋 Prerequisites

For maximum convenience, please make sure these minimum system requirement(s) are met and have installed the following software:

• Python Runtime >= 3.12

• Disk Memory Storage < 1 MB

• Supported Platform(s)

  • Windows 11

  • macOS

  • Linux Ubuntu

🛠️ Installation

This tool can be installed as a Python PIP package, either globally or within virtual environments.

1. First, simply copy and paste the pip install qlogicae-logis command into your command-line interface of choice. If you intend to use a Python virtual environment, activate your environment first, then run the installation command.

2. After the installation completes, run qlogicae-logis about version. An error-free display showing the application version should confirm a successful installation, at minimum.

🏗️ Development

📋 Prerequisites

For maximum convenience, please make sure these minimum system requirement(s) are met and have installed the following software:

• .pyenv file (Please send a request via email)

• Python Runtime >= 3.12

• Supported Platform(s)

  • Windows 11

  • macOS

  • Linux Ubuntu

🛠️ Setup

You can begin developing and contributing on this project by following these recommended instructions first:

1. Fork this repository.

2. Clone your forked repository to a filesystem path of your choosing.

3. Open a console of your choosing and navigate to your forked project folder.

4. Create a virtual environment via python3 -m venv .venv.

5. Activate your virtual environment, depending on your currently running operating system, via one of the following:

   • Linux: source .venv/bin/activate

   • MacOS: .venv\Scripts\activate.bat

   • Windows: .venv\Scripts\Activate.ps1

6. Install all development dependencies found within 'project.optional-dependencies' within the pyproject.toml file.

🤝 Contribution

Meaningful contributions always welcome! Having said that, please be guided with the following documentation based on what aspects of the project you want to be improved upon.

• Contribution Guidelines

• Security Guidelines

• Bug Reports

• Feature Requests

• Pull Requests

🏛️ Legalities

📋 License

The project is currently under the MIT License.