bumpy-cli 0.1.0__tar.gz

bumpy_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel-Felipe-Santana-Batista
+
+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.

bumpy_cli-0.1.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: bumpy-cli
+Version: 0.1.0
+Summary: CLI para gerenciar versoes de jobs em pipelines.
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,pipeline,versionamento,jobs
+Author: Daniel Felipe Santana Batista
+Author-email: daniel.sbatista@shopee.com
+Requires-Python: >=3.12
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Natural Language :: Portuguese (Brazilian)
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Dist: typer (>=0.27.2,<0.28.0)
+Project-URL: Documentation, https://bumpy-cli.readthedocs.io/pt-br/latest/
+Project-URL: Homepage, https://github.com/iamDFSB/Bumpy-CLI
+Project-URL: Repository, https://github.com/iamDFSB/Bumpy-CLI
+Description-Content-Type: text/markdown
+
+![Bumpy CLI](docs/assets/images/logo.png)
+
+# Bumpy CLI
+
+[![Documentação](https://img.shields.io/badge/Documenta%C3%A7%C3%A3o-Read%20the%20Docs-blue?logo=readthedocs)](https://bumpy-cli.readthedocs.io/pt-br/latest/)
+[![Codecov](https://codecov.io/gh/iamDFSB/Bumpy-CLI/branch/main/graph/badge.svg)](https://app.codecov.io/github/iamDFSB/Bumpy-CLI)
+[![CI](https://github.com/iamDFSB/Bumpy-CLI/actions/workflows/pipeline.yaml/badge.svg)](https://github.com/iamDFSB/Bumpy-CLI/actions)
+
+O Bumpy CLI ajuda a atualizar as versões dos jobs mantidos em arquivos `version`
+de um pipeline. Com ele, você pode incrementar ou decrementar `major`, `minor`
+ou `patch` de um job específico ou de todos os jobs de um ambiente.
+
+## Requisitos
+
+- Python 3.12 ou superior;
+- um projeto com a estrutura de pastas descrita abaixo.
+
+## Instalação
+
+Como o Bumpy é uma ferramenta de linha de comando, recomendamos instalá-lo com
+[pipx](https://pipx.pypa.io/), que mantem as dependencias isoladas:
+
+```bash
+pipx install bumpy-cli
+```
+
+Também é possível instalar no ambiente Python ativo:
+
+```bash
+python -m pip install bumpy-cli
+```
+
+Confirme a instalacao e veja os comandos disponiveis:
+
+```bash
+bumpy --help
+```
+
+## Prepare o projeto
+
+Execute os comandos a partir da raiz do projeto que contem a pasta `pipeline`.
+Cada job precisa ter um arquivo `version` com tres numeros separados por ponto:
+
+```text
+pipeline/
+├── prd-marketplace/
+│   └── meu-cron/
+│       └── version
+└── uat/
+    └── meu-cron/
+        └── version
+```
+
+Por exemplo, o arquivo `pipeline/prd-marketplace/meu-cron/version` pode conter:
+
+```text
+1.2.3
+```
+
+## Uso
+
+### Atualizar um job
+
+Por padrão, os comandos atuam no ambiente `prd-marketplace`:
+
+```bash
+bumpy job up meu-cron patch
+```
+
+Esse comando altera `1.2.3` para `1.2.4`. Para atualizar outro segmento:
+
+```bash
+bumpy job up meu-cron minor
+bumpy job up meu-cron major
+```
+
+Use `down` para decrementar o segmento. O valor não pode ficar abaixo de zero:
+
+```bash
+bumpy job down meu-cron patch
+```
+
+Para atuar no ambiente `uat`, adicione `--uat`:
+
+```bash
+bumpy job up meu-cron patch --uat
+```
+
+### Atualizar todos os jobs de um ambiente
+
+Os comandos `all` atualizam todos os jobs dentro do ambiente selecionado:
+
+```bash
+bumpy all up patch
+bumpy all down minor
+bumpy all up major --uat
+```
+
+Cada pasta de job do ambiente precisa conter um arquivo `version` válido.
+
+## Ajuda
+
+Consulte a ajuda geral ou a de um grupo de comandos:
+
+```bash
+bumpy --help
+bumpy job --help
+bumpy all --help
+```
+
+## Desenvolvimento
+
+O código-fonte, as instruções para contribuir e a documentação do projeto estão
+no [repositorio no GitHub](https://github.com/iamDFSB/Bumpy-CLI).
+

bumpy_cli-0.1.0/README.md

@@ -0,0 +1,114 @@
+![Bumpy CLI](docs/assets/images/logo.png)
+
+# Bumpy CLI
+
+[![Documentação](https://img.shields.io/badge/Documenta%C3%A7%C3%A3o-Read%20the%20Docs-blue?logo=readthedocs)](https://bumpy-cli.readthedocs.io/pt-br/latest/)
+[![Codecov](https://codecov.io/gh/iamDFSB/Bumpy-CLI/branch/main/graph/badge.svg)](https://app.codecov.io/github/iamDFSB/Bumpy-CLI)
+[![CI](https://github.com/iamDFSB/Bumpy-CLI/actions/workflows/pipeline.yaml/badge.svg)](https://github.com/iamDFSB/Bumpy-CLI/actions)
+
+O Bumpy CLI ajuda a atualizar as versões dos jobs mantidos em arquivos `version`
+de um pipeline. Com ele, você pode incrementar ou decrementar `major`, `minor`
+ou `patch` de um job específico ou de todos os jobs de um ambiente.
+
+## Requisitos
+
+- Python 3.12 ou superior;
+- um projeto com a estrutura de pastas descrita abaixo.
+
+## Instalação
+
+Como o Bumpy é uma ferramenta de linha de comando, recomendamos instalá-lo com
+[pipx](https://pipx.pypa.io/), que mantem as dependencias isoladas:
+
+```bash
+pipx install bumpy-cli
+```
+
+Também é possível instalar no ambiente Python ativo:
+
+```bash
+python -m pip install bumpy-cli
+```
+
+Confirme a instalacao e veja os comandos disponiveis:
+
+```bash
+bumpy --help
+```
+
+## Prepare o projeto
+
+Execute os comandos a partir da raiz do projeto que contem a pasta `pipeline`.
+Cada job precisa ter um arquivo `version` com tres numeros separados por ponto:
+
+```text
+pipeline/
+├── prd-marketplace/
+│   └── meu-cron/
+│       └── version
+└── uat/
+    └── meu-cron/
+        └── version
+```
+
+Por exemplo, o arquivo `pipeline/prd-marketplace/meu-cron/version` pode conter:
+
+```text
+1.2.3
+```
+
+## Uso
+
+### Atualizar um job
+
+Por padrão, os comandos atuam no ambiente `prd-marketplace`:
+
+```bash
+bumpy job up meu-cron patch
+```
+
+Esse comando altera `1.2.3` para `1.2.4`. Para atualizar outro segmento:
+
+```bash
+bumpy job up meu-cron minor
+bumpy job up meu-cron major
+```
+
+Use `down` para decrementar o segmento. O valor não pode ficar abaixo de zero:
+
+```bash
+bumpy job down meu-cron patch
+```
+
+Para atuar no ambiente `uat`, adicione `--uat`:
+
+```bash
+bumpy job up meu-cron patch --uat
+```
+
+### Atualizar todos os jobs de um ambiente
+
+Os comandos `all` atualizam todos os jobs dentro do ambiente selecionado:
+
+```bash
+bumpy all up patch
+bumpy all down minor
+bumpy all up major --uat
+```
+
+Cada pasta de job do ambiente precisa conter um arquivo `version` válido.
+
+## Ajuda
+
+Consulte a ajuda geral ou a de um grupo de comandos:
+
+```bash
+bumpy --help
+bumpy job --help
+bumpy all --help
+```
+
+## Desenvolvimento
+
+O código-fonte, as instruções para contribuir e a documentação do projeto estão
+no [repositorio no GitHub](https://github.com/iamDFSB/Bumpy-CLI).

bumpy_cli-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "bumpy-cli"
+version = "0.1.0"
+description = "CLI para gerenciar versoes de jobs em pipelines."
+authors = [
+    {name = "Daniel Felipe Santana Batista",email = "daniel.sbatista@shopee.com"}
+]
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+keywords = ["cli", "pipeline", "versionamento", "jobs"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Natural Language :: Portuguese (Brazilian)",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "typer (>=0.27.2,<0.28.0)"
+]
+
+[project.urls]
+Homepage = "https://github.com/iamDFSB/Bumpy-CLI"
+Repository = "https://github.com/iamDFSB/Bumpy-CLI"
+Documentation = "https://bumpy-cli.readthedocs.io/pt-br/latest/"
+
+[project.scripts]
+bumpy = "bumpy.main:app"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+packages = [{ include = "bumpy", from = "src" }]
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.1.1,<10.0.0)",
+    "pytest-cov (>=7.1.0,<8.0.0)",
+    "blue (>=0.9.1,<0.10.0)",
+    "isort (>=9.0.1,<10.0.0)"
+]
+doc = [
+    "mkdocs (>=1.6.1,<2.0.0)",
+    "mkdocs-material (>=9.0,<10.0)",
+    "mkdocstrings (>=1.0.6,<2.0.0)",
+    "mkdocstrings-python (>=2.0.9,<3.0.0)"
+]
+
+[tool.pytest.ini_options]
+pythonpath = "."
+addopts = "--doctest-modules"
+
+[tool.isort]
+profile = "black"
+line_length = 79

bumpy_cli-0.1.0/src/bumpy/commands/__init__.py

@@ -0,0 +1,4 @@
+from .job import job_app
+from .pipeline import pipeline_app
+
+__all__ = ['job_app', 'pipeline_app']

bumpy_cli-0.1.0/src/bumpy/commands/job.py

@@ -0,0 +1,49 @@
+import typer
+from rich.console import Console
+
+from bumpy.file_client import FileClient
+from bumpy.models import VersionPart
+
+# Criamos um sub-app dedicado a ações de "job"
+job_app = typer.Typer(help='Comandos para manipular um unico job especifico.')
+console = Console()
+
+
+@job_app.command('up')
+def job_up(
+    name: str = typer.Argument(..., help='Nome da pasta do job.'),
+    part: VersionPart = typer.Argument(
+        VersionPart.patch,
+        help='Parte da versão a atualizar (major, minor, patch)',
+    ),
+    uat: bool = typer.Option(
+        False, '--uat', help='Aplica no ambiente de UAT.'
+    ),
+):
+    """Aumenta a versao de um job especifico."""
+    console.print(
+        f"[bold green]Aumentando versão do job '{name}'...[/bold green]"
+    )
+    ambient = 'uat' if uat else 'prd-marketplace'
+    path_str = f'{ambient}/{name}/version'
+    FileClient().increase(segment=part.value, pipeline_path=path_str)
+
+
+@job_app.command('down')
+def job_down(
+    name: str = typer.Argument(..., help='Nome da pasta do job.'),
+    part: VersionPart = typer.Argument(
+        VersionPart.patch,
+        help='Parte da versão a atualizar (major, minor, patch)',
+    ),
+    uat: bool = typer.Option(
+        False, '--uat', help='Aplica no ambiente de UAT.'
+    ),
+):
+    """Diminui a versao de um job especifico."""
+    console.print(
+        f"[bold yellow]Diminuindo versão do job '{name}'...[/bold yellow]"
+    )
+    ambient = 'uat' if uat else 'prd-marketplace'
+    path_str = f'{ambient}/{name}/version'
+    FileClient().decrease(segment=part.value, pipeline_path=path_str)

bumpy_cli-0.1.0/src/bumpy/commands/pipeline.py

@@ -0,0 +1,49 @@
+import typer
+from rich.console import Console
+
+from bumpy.file_client import FileClient
+from bumpy.models import VersionPart
+
+# Criamos um sub-app dedicado a ações do "pipeline" em lote
+pipeline_app = typer.Typer(
+    help='Comandos para manipular todos os jobs do pipeline.'
+)
+console = Console()
+
+
+@pipeline_app.command('up')
+def pipeline_up(
+    part: VersionPart = typer.Argument(
+        VersionPart.patch,
+        help='Parte da versão a atualizar (major, minor, patch)',
+    ),
+    uat: bool = typer.Option(
+        False, '--uat', help='Aplica no ambiente de UAT.'
+    ),
+):
+    """Aumenta a versao de TODOS os jobs do pipeline de uma vez."""
+    console.print(
+        '[bold green]Subindo a versão de todos os jobs no ambiente selecionado...[/bold green]'
+    )
+    ambient = 'uat' if uat else 'prd-marketplace'
+    path_str = f'pipeline/{ambient}'
+    FileClient().increase_all(segment=part.value, pipeline_path=path_str)
+
+
+@pipeline_app.command('down')
+def pipeline_down(
+    part: VersionPart = typer.Argument(
+        VersionPart.patch,
+        help='Parte da versão a atualizar (major, minor, patch)',
+    ),
+    uat: bool = typer.Option(
+        False, '--uat', help='Aplica no ambiente de UAT.'
+    ),
+):
+    """Diminui a versao de TODOS os jobs do pipeline de uma vez."""
+    console.print(
+        '[bold yellow]Diminuindo a versão de todos os jobs no ambiente selecionado...[/bold yellow]'
+    )
+    ambient = 'uat' if uat else 'prd-marketplace'
+    path_str = f'pipeline/{ambient}'
+    FileClient().decrease_all(segment=part.value, pipeline_path=path_str)

bumpy_cli-0.1.0/src/bumpy/exceptions/file_client_exceptions.py

@@ -0,0 +1,23 @@
+class EmptyFileException(Exception):
+    def __init__(self, file_name: str):
+        message = f'An error occured, the file {file_name} is empty'
+        super().__init__(message)
+
+
+class MissingSegmentsException(ValueError):
+    def __init__(self, file_name: str):
+        message = f'An error occured, the file {file_name} must have 3 segments (major.minor.patch)'
+        super().__init__(message)
+
+
+class NotFoundPipelinePathException(FileNotFoundError):
+    def __init__(self):
+        message = 'An error occured, pipeline path was not found'
+        super().__init__(message)
+
+
+class VersionUnderflowError(Exception):
+    def __init__(self, file_name: str, version_part: str = 'versão'):
+        super().__init__(
+            f'An error occured, It is not possible to decrease the {version_part} in {file_name}: the minimum value is 0.'
+        )

bumpy_cli-0.1.0/src/bumpy/file_client.py

@@ -0,0 +1,90 @@
+import os
+from pathlib import Path
+
+from .exceptions.file_client_exceptions import (
+    EmptyFileException,
+    MissingSegmentsException,
+    NotFoundPipelinePathException,
+    VersionUnderflowError,
+)
+
+
+class FileClient:
+    def __init__(self) -> None:
+        self.__absolute_path = Path.cwd()
+        self.__current_dir = None
+        self.__segment = {}
+
+    def __validate_pipeline_path(self, pipeline_path: str) -> None:
+        for f in self.__absolute_path.iterdir():
+            list_path = list(f.glob(pipeline_path))
+            if list_path:
+                self.__current_dir = list_path[0]
+                return None
+        raise NotFoundPipelinePathException()
+
+    def __get_current_version(self) -> None:
+        with open(self.__current_dir, 'r') as file:
+            content = file.read()
+            if not content:
+                raise EmptyFileException(str(self.__current_dir))
+
+            version = content.split('.')
+            if len(version) < 3:
+                raise MissingSegmentsException(str(self.__current_dir))
+
+            self.__segment['major'] = int(version[0])
+            self.__segment['minor'] = int(version[1])
+            self.__segment['patch'] = int(version[2])
+
+    def __update_file_version(self) -> None:
+        major = self.__segment['major']
+        minor = self.__segment['minor']
+        patch = self.__segment['patch']
+
+        with open(self.__current_dir, 'w') as file:
+            new_version = f'{major}.{minor}.{patch}'
+            file.write(new_version)
+
+    def increase(self, segment: str, pipeline_path: str) -> None:
+        self.__validate_pipeline_path(pipeline_path)
+        self.__get_current_version()
+
+        self.__segment[segment] += 1
+
+        self.__update_file_version()
+
+    def decrease(self, segment: str, pipeline_path: str) -> None:
+        self.__validate_pipeline_path(pipeline_path)
+        self.__get_current_version()
+
+        if self.__segment[segment] == 0:
+            raise VersionUnderflowError(pipeline_path, segment)
+
+        self.__segment[segment] -= 1
+
+        self.__update_file_version()
+
+    def increase_all(self, segment: str, pipeline_path: str) -> None:
+        folder_paths = self.__absolute_path / pipeline_path
+
+        for folder_name in os.listdir(folder_paths):
+            version_path = folder_paths / folder_name / 'version'
+            self.__current_dir = version_path
+            self.__get_current_version()
+            self.__segment[segment] += 1
+            self.__update_file_version()
+
+    def decrease_all(self, segment: str, pipeline_path: str) -> None:
+        folder_paths = self.__absolute_path / pipeline_path
+
+        for folder_name in os.listdir(folder_paths):
+            version_path = folder_paths / folder_name / 'version'
+            self.__current_dir = version_path
+            self.__get_current_version()
+
+            if self.__segment[segment] == 0:
+                raise VersionUnderflowError(folder_name, segment)
+
+            self.__segment[segment] -= 1
+            self.__update_file_version()

bumpy_cli-0.1.0/src/bumpy/main.py

@@ -0,0 +1,15 @@
+import typer
+
+from bumpy.commands import job_app, pipeline_app
+
+# App principal (Raiz da Árvore)
+app = typer.Typer(
+    help='Bumpy: Gerenciador de versoes para pipelines multi-plataforma.'
+)
+
+# Registrando os galhos/nós na árvore de comandos
+app.add_typer(job_app, name='job')
+app.add_typer(pipeline_app, name='all')
+
+if __name__ == '__main__':
+    app()

bumpy_cli-0.1.0/src/bumpy/models.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class VersionPart(str, Enum):
+    major = 'major'
+    minor = 'minor'
+    patch = 'patch'
+
+    def get_index_position(self):
+        return {'major': 0, 'minor': 1, 'patch': 2}[self.value]