diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c3a96db..bdd6f2c 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,3 +9,8 @@ updates: directory: "/" schedule: interval: "weekly" + + - package-ecosystem: pip + directory: "/" + schedule: + interval: weekly diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f24c05d..c154cce 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,13 +18,17 @@ jobs: uses: github/super-linter@v7 env: DEFAULT_BRANCH: main - FILTER_REGEX_EXCLUDE: \.github.*|catalog-info\.yaml + FILTER_REGEX_EXCLUDE: \.github.* GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + LINTER_RULES_PATH: . + PYTHON_BLACK_CONFIG_FILE: pyproject.toml + PYTHON_ISORT_CONFIG_FILE: pyproject.toml + PYTHON_PYLINT_CONFIG_FILE: pyproject.toml VALIDATE_ALL_CODEBASE: false VALIDATE_CHECKOV: false - VALIDATE_DOCKERFILE_HADOLINT: false VALIDATE_JSCPD: false VALIDATE_MARKDOWN_PRETTIER: false + VALIDATE_MARKDOWN: false VALIDATE_PYTHON_FLAKE8: false VALIDATE_PYTHON_PYINK: false VALIDATE_PYTHON_RUFF: false diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ab7bacb..5c8aeed 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,8 +11,8 @@ on: default: "yes" jobs: - publish: - name: Publish PyPi + deploy: + name: Publish to PyPI runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 diff --git a/.isort.cfg b/.isort.cfg deleted file mode 100644 index bf7b9fb..0000000 --- a/.isort.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[settings] -profile=black \ No newline at end of file diff --git a/README.md b/README.md index 7bb2720..15f6c5e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Kompozit -![Docker Pulls](https://img.shields.io/docker/pulls/veerendra2/kompozit) ![PyPI - Status](https://img.shields.io/pypi/status/kompozit) ![PyPI - Version](https://img.shields.io/pypi/v/kompozit) [![Release](https://github.com/veerendra2/kompozit/actions/workflows/release.yml/badge.svg)](https://github.com/veerendra2/kompozit/actions/workflows/release.yml) - -> ℹ Mostly likely you may want to use [Use multiple Compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) in Docker Compose itself. +[![Docker Pulls](https://img.shields.io/docker/pulls/veerendra2/kompozit)](https://hub.docker.com/r/veerendra2/kompozit) [![PyPI - Status](https://img.shields.io/pypi/status/kompozit)](https://pypi.org/project/kompozit/) [![PyPI - Version](https://img.shields.io/pypi/v/kompozit)](https://pypi.org/project/kompozit/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/kompozit)](https://pypi.org/project/kompozit/) [![Release](https://github.com/veerendra2/kompozit/actions/workflows/release.yml/badge.svg)](https://github.com/veerendra2/kompozit/actions/workflows/release.yml) + +> ℹ Mostly likely you may want to use [Use multiple Compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) in Docker Compose itself. Declarative Configuration Management Tool for Docker Compose. @@ -43,7 +43,7 @@ Additionally, kompozit allows you to combine multiple `docker-compose.yml` files ```bash python -m pip install kompozit -kompozit --help +kompozit -h usage: kompozit [-h] [-b BUILD_PATH] [-o OUTPUT_DIR] [-v] Declarative Configuration Management Tool for Docker Compose. @@ -51,7 +51,7 @@ Declarative Configuration Management Tool for Docker Compose. options: -h, --help show this help message and exit -b, --build BUILD_PATH - Path to a directory containing 'komposition.yaml'. (default: .) + Path to a directory containing 'kompozition.yaml' or 'kompozition.yml'. (default: .) -o, --output-dir OUTPUT_DIR Directory to save the generated Docker Compose files. (default: None) -v, --version Show kompozit version @@ -65,7 +65,7 @@ options: docker pull veerendra2/kompozit ``` -## Usage ⚙️ +## Usage Examples ⚙️ ```bash git clone git@github.com:veerendra2/kompozit.git diff --git a/kompozit/kompozit.py b/kompozit/kompozit.py index a24205b..4f40044 100755 --- a/kompozit/kompozit.py +++ b/kompozit/kompozit.py @@ -12,7 +12,7 @@ from jsonpatch import JsonPatchConflict from jsonpointer import JsonPointerException -__version__ = "0.2.0-beta" +__version__ = "0.2.1-beta" CONFIG_FILE_NAMES = ["kompozition.yaml", "kompozition.yml"] @@ -37,7 +37,7 @@ def parse_arguments(): dest="build_path", type=str, required=False, - help="Path to a directory containing 'komposition.yaml'.", + help="Path to a directory containing 'kompozition.yaml' or 'kompozition.yml'.", ) parser.add_argument( "-o", diff --git a/pyproject.toml b/pyproject.toml index 60006d6..1f8bbe2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,9 +6,10 @@ build-backend = "setuptools.build_meta" line-length = 88 [tool.pylint.messages_control] -disable = [ - "C0301" -] +disable = ["C0301", "E0401"] + +[tool.isort] +profile = "black" [tool.mypy] ignore_missing_imports = true @@ -17,4 +18,4 @@ ignore_missing_imports = true output-format = "colorized" [tool.pylint.reporter] -max-line-length = 120 \ No newline at end of file +max-line-length = 120 diff --git a/setup.py b/setup.py index 75ee6f2..5053362 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,6 @@ """ setup.py """ -# pylint: disable=C0301 import re @@ -30,7 +29,7 @@ "Documentation": "https://veerendra2.gitbook.io/kompozit", }, keywords=["gitops", "cicd", "docker-compose", "configuration management"], - license="MIT", + license="Apache License", classifiers=[ "Development Status :: 4 - Beta", "Intended Audience :: System Administrators",