Metadata-Version: 2.1
Name: gitoptim
Version: 0.1.0.dev9
Summary: SDK tool to connect Gitlab pipelines with Workflows
Author: Łukasz Leszko
Author-email: leszko.lucas@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: httpx (>=0.27.0,<0.28.0)
Requires-Dist: pydantic (>=2.6.3,<3.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# Gitoptim SDK

## Introduction

Gitoptim SDK is a CLI tool that enables integration of Gitlab pipelines and Workflows. It is designed to be used in
CI/CD jobs.

## Commands

### memlab

TODO

## Development

### Prerequisites

- Python 3.11 or later
- [Poetry](https://python-poetry.org/) for dependency management

### Setup

1. Install dependencies using `poetry install --with dev`
2. Install git hooks using `pre-commit install`. This will run linters and formatters before each push to repository.

#### Pycharm

1. Set the Python interpreter to the one created by Poetry. This can be done by going
   to `File -> Settings -> Project-> Python Interpreter` and selecting the interpreter created by Poetry. Path to the
   interpreter can be found by running `poetry env info` in the terminal.
2. Install Pylint plugin for Pycharm.
3. Enable "Reformat code" on save. This can be done by going to `File -> Settings -> Tools ->
Actions On Save`.

### How to run

1. Run `poetry shell` to activate the virtual environment.
2. Run `python -m gitoptim` to start the CLI.

**Important**: In order to push to repository you need to have poetry shell enabled so that git hooks can run.

