diff --git a/templates/md2conf/README.md b/templates/md2conf/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0c9cfbb5e200ab63729752e7b0dc2c837282493f --- /dev/null +++ b/templates/md2conf/README.md @@ -0,0 +1,48 @@ +# HTTP-API + +## Documentation + +The documentation of this project is located in confluence: +https://beebryte.atlassian.net/wiki/spaces/AQTMN/overview?homepageId=452002085 + +## Installation + +```bash +pip install -r requirements.txt +``` + +Define the following environment variables: + +```bash +CONFLUENCE_API_KEY=<your api key>; +CONFLUENCE_DOMAIN=beebryte.atlassian.net; +CONFLUENCE_PATH=/wiki/; +CONFLUENCE_SPACE_KEY=AQTMN; # The space key of the space to which pages belongs +CONFLUENCE_USER_NAME=<your username>; +``` + +## Usage + +```bash +python -m md2conf . +``` + +## Pre-commit hooks + +Please use the pre-commit hooks provided in this repository to maintain consistency in +the codebase. + +### Setup + +```bash +pip install --upgrade pip +pip install pre-commit +pre-commit install +pre-commit autoupdate +``` + +### Manual use + +```bash +pre-commit run --all-files +``` \ No newline at end of file diff --git a/templates/md2conf/md2conf.yml b/templates/md2conf/md2conf.yml new file mode 100644 index 0000000000000000000000000000000000000000..6c0fa52b9eb3b826800f8744a5460091bc5a01a7 --- /dev/null +++ b/templates/md2conf/md2conf.yml @@ -0,0 +1,12 @@ +include: + - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba/r2devops_catalog/r2_metadata/python_install@latest.yaml' + +black: + extends: + - .python_install + stage: production + variables: + PYTHON_SETUP: "pip install markdown-to-confluence" + script: + - !reference [.python_install, script] + - python -m md2conf ${PROJECT_PATH} diff --git a/templates/python/code_quality/black/black.yml b/templates/python/code_quality/black/black.yml index 3be5bb440b3321ee08619b610ed2c2a14de8feaa..19eac16d713f190a125cfc74ae108329ffe2a0be 100644 --- a/templates/python/code_quality/black/black.yml +++ b/templates/python/code_quality/black/black.yml @@ -1,5 +1,5 @@ include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba-templates/r2devops_catalog/r2_metadata/python_install@latest.yaml' + - remote: 'https://gitlab.com/dorianturba-templates/r2devops_catalog/-/raw/main/templates/python/partial/python_install/python_install.yml' black: extends: diff --git a/templates/python/code_quality/flake8/flake8.yml b/templates/python/code_quality/flake8/flake8.yml index 21abd6c8eb5e5b7f1ed2b4a8e75c9a3dec9f25d9..7254dfddd635333447e3149c953ff41432dc51d5 100644 --- a/templates/python/code_quality/flake8/flake8.yml +++ b/templates/python/code_quality/flake8/flake8.yml @@ -1,5 +1,5 @@ include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba-templates/r2devops_catalog/r2_metadata/python_install@latest.yaml' + - remote: 'https://gitlab.com/dorianturba-templates/r2devops_catalog/-/raw/main/templates/python/partial/python_install/python_install.yml' flake8: extends: diff --git a/templates/python/code_quality/isort/isort.yml b/templates/python/code_quality/isort/isort.yml index 8f87229b8f4e2f361dd64ae5d1254015e149dc68..e0dec8fdff3a7202c70dd07b997c29cc6bafaf32 100644 --- a/templates/python/code_quality/isort/isort.yml +++ b/templates/python/code_quality/isort/isort.yml @@ -1,5 +1,5 @@ include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba-templates/r2devops_catalog/r2_metadata/python_install@latest.yaml' + - remote: 'https://gitlab.com/dorianturba-templates/r2devops_catalog/-/raw/main/templates/python/partial/python_install/python_install.yml' isort: extends: diff --git a/templates/python/code_quality/pre-commit-autoupdate/pre-commit.yml b/templates/python/code_quality/pre-commit-autoupdate/pre-commit-autoupdate.yml similarity index 100% rename from templates/python/code_quality/pre-commit-autoupdate/pre-commit.yml rename to templates/python/code_quality/pre-commit-autoupdate/pre-commit-autoupdate.yml diff --git a/templates/python/dependency_management/requirements-compile/requirements-compile.yml b/templates/python/dependency_management/requirements-compile/requirements-compile.yml index 4288360ffe8fde513465955f5b514a09aebb137f..40c87cbbccebd8aeae8a68642779d9358be00db4 100644 --- a/templates/python/dependency_management/requirements-compile/requirements-compile.yml +++ b/templates/python/dependency_management/requirements-compile/requirements-compile.yml @@ -1,5 +1,5 @@ include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba-templates/r2devops_catalog/r2_metadata/python_install@latest.yaml' + - remote: 'https://gitlab.com/dorianturba-templates/r2devops_catalog/-/raw/main/templates/python/partial/python_install/python_install.yml' requirements-compile: extends: diff --git a/templates/python/testing/pytest/pytest.yml b/templates/python/testing/pytest/pytest.yml index cb384ee46201dd061c9941a3340ed1b3908bdaf7..7751d7f8cada38903c3d9395dcd4d5261ea04383 100644 --- a/templates/python/testing/pytest/pytest.yml +++ b/templates/python/testing/pytest/pytest.yml @@ -1,5 +1,5 @@ include: - - remote: 'https://api.r2devops.io/job/r/gitlab/dorianturba-templates/r2devops_catalog/r2_metadata/python_install@latest.yaml' + - remote: 'https://gitlab.com/dorianturba-templates/r2devops_catalog/-/raw/main/templates/python/partial/python_install/python_install.yml' pytest: extends: