Initial commit

Author: KOLANICH

.ci/aptPackagesToInstall.txt

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+insert_final_newline = true
+end_of_line = lf
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.ci/pythonPackagesToInstallFromGit.txt

@@ -0,0 +1 @@
+KOLANICH/python_project_boilerplate.py

.editorconfig

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: "all"

.github/.templateMarker

@@ -0,0 +1,15 @@
+name: CI
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: typical python workflow
+        uses: KOLANICH-GHActions/typical-python-workflow@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/dependabot.yml

@@ -0,0 +1,10 @@
+__pycache__
+*.py[co]
+/*.egg-info
+*.srctrlbm
+*.srctrldb
+build
+dist
+.eggs
+monkeytype.sqlite3
+/.ipynb_checkpoints

.github/workflows/CI.yml

@@ -0,0 +1,51 @@
+image: registry.gitlab.com/kolanich-subgroups/docker-images/fixed_python:latest
+
+variables:
+  DOCKER_DRIVER: overlay2
+  SAST_ANALYZER_IMAGE_TAG: latest
+  SAST_DISABLE_DIND: "true"
+  SAST_CONFIDENCE_LEVEL: 5
+  CODECLIMATE_VERSION: latest
+
+include:
+  - template: SAST.gitlab-ci.yml
+  - template: Code-Quality.gitlab-ci.yml
+  - template: License-Management.gitlab-ci.yml
+
+build:
+  tags:
+    - shared
+    - linux
+  stage: build
+  variables:
+    GIT_DEPTH: "1"
+    PYTHONUSERBASE: ${CI_PROJECT_DIR}/python_user_packages
+
+  before_script:
+    - export PATH="$PATH:$PYTHONUSERBASE/bin" # don't move into `variables`
+    - apt-get update
+    # todo:
+    #- apt-get -y install 
+    #- pip3 install --upgrade 
+    #- python3 ./fix_python_modules_paths.py
+
+  script:
+    - python3 -m build -nw bdist_wheel
+    - mv ./dist/*.whl ./dist/GitHubReadMeRender-0.CI-py3-none-any.whl
+    - pip3 install --upgrade ./dist/*.whl
+    - coverage run --source=GitHubReadMeRender -m --branch pytest --junitxml=./rspec.xml ./tests/test.py
+    - coverage report -m
+    - coverage xml
+
+  coverage: "/^TOTAL(?:\\s+\\d+){4}\\s+(\\d+%).+/"
+
+  cache:
+    paths:
+      - $PYTHONUSERBASE
+
+  artifacts:
+    paths:
+      - dist
+    reports:
+      junit: ./rspec.xml
+      cobertura: ./coverage.xml

.gitignore

@@ -0,0 +1 @@
+No codes of conduct!

.gitlab-ci.yml

@@ -0,0 +1,28 @@
+from pathlib import PurePath
+from warnings import warn
+
+from LMRender import SF, DEFAULT_RENDERER
+from miniGHAPI.GitHubAPI import CT, Repo
+
+__all__ = ("getAndRenderReadMe",)
+
+
+def getAndRenderReadMe(repoObj: Repo, targetFormat: SF = SF.gfm_ansi):
+	readMe = repoObj.getReadMe(accept=CT.json)
+
+	rawSrc = readMe["$content"]
+	fmt = SF.fromFileName(PurePath(readMe["name"]))
+	unavail = DEFAULT_RENDERER.isSourceUnavailable(fmt)
+
+	def fallback():
+		nonlocal rawSrc, fmt
+		rawSrc = repoObj.getReadMe(accept=CT.html)["$content"]
+		fmt = SF.html
+
+	if fmt is None:
+		fallback()
+	elif unavail:
+		warn("Install " + " or ".join(unavail) + " to spare an API request. Requesting GitHub to render the ReadMe into HTML.")
+		fallback()
+
+	return DEFAULT_RENDERER.render(rawSrc, fmt, targetFormat)