Metadata-Version: 2.4
Name: devops-overseer
Version: 0.0.3
Summary: DevOps overseer to manage process automations and conformity
Author-email: mot0ko <dourval.clement@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Motoko
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/mot0ko/devops.overseer
Project-URL: Source, https://github.com/mot0ko/devops.overseer
Project-URL: Issues, https://github.com/mot0ko/devops.overseer/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-dateutil>=2.9.0
Requires-Dist: requests>=2.32.5
Requires-Dist: pydantic>=2.12.1
Requires-Dist: pyyaml>=6.0.2
Dynamic: license-file

# devops.overseer

A DevOps helper python module to monitor and automate all kinds of tasks related to either process, migrations, reporting, monitoring etc.

# Installation

Clone the repository and `cd ` into it.

## Virtual environment

Make sure you have `vevn` installed (example on Ubuntu: `sudo apt install python3-venv`).
From the root of the repository, if you don't have another preference onto where to get the venv, just create it here:

`python3 -v venv ./.venv`

> INFO: The `venv` directory is ignored at the root.

## Requirements

Just install both requirements file in your virtual environment to make sure you have access to all the processes:

```
pip install -r ./requirements.dev.txt
pip install -r ./requirements.txt
```

## Building

You can simply build the package after pip installing both requirements file using this command:

`python3 -m build`

## Installation

### Locally

just run the usual pip install:

`pip install .`

## Calling the CLI

You should now be able to just call `devops-overseer` from your current shell while having your virtual environment activated

# Contributing

## Commiting

This repository tries to follow as best as it cana the [conventional commits specification](https://www.conventionalcommits.org).
The accepted types for commit messages are:
- feat
- fix
- docs
- style
- refactor
- perf
- test
- build
- ci
- chore
- revert

## Commands

* `devops-overseer` - CLI call (parameters will come).

## Project layout

    mkdocs.yml    # The configuration file.
    docs/         # mkdocs documentation
    src/          # main source directory
    tests/        # unit tests directory

# Full documentation

You can find the full documentation [here](https://mot0ko.github.io/devops.overseer/)
