From ea3128326317f2f6627906e81e5768a3f0826291 Mon Sep 17 00:00:00 2001 From: Romain Deville <code@romaindeville.fr> Date: Tue, 13 Apr 2021 17:28:52 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9E=95=F0=9F=93=8C=20Add=20python=20dependen?= =?UTF-8?q?cies?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add pinned and unpinned depedencies for docs, dev and prod environment. --- requirements.dev.in | 48 +++++++++++++ requirements.dev.txt | 115 ++++++++++++++++++++++++++++++ requirements.docs.in | 61 ++++++++++++++++ requirements.docs.txt | 162 ++++++++++++++++++++++++++++++++++++++++++ requirements.prod.in | 1 + requirements.prod.txt | 1 + 6 files changed, 388 insertions(+) create mode 100644 requirements.dev.in create mode 100644 requirements.dev.txt create mode 100644 requirements.docs.in create mode 100644 requirements.docs.txt create mode 120000 requirements.prod.in create mode 120000 requirements.prod.txt diff --git a/requirements.dev.in b/requirements.dev.in new file mode 100644 index 0000000..fc7ada6 --- /dev/null +++ b/requirements.dev.in @@ -0,0 +1,48 @@ +### BEGIN MKDOCS TEMPLATE ### +### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !### +### Modified content will be overwritten when updating.### + +# DEVELOPER REQUIREMENTS +# ============================================================ +# DESCRIPTION: +# Mainly testing suite tools to ensure and/or enfore code syntax + +# Testing tools +# ------------------------------------------------------------ +# Tox is a generic virtualenv management and test command line tool +# https://pypi.org/project/tox/ +tox + +# The uncompromising code formatter. +# https://pypi.org/project/black/ +black + +# A Python utility / library to sort Python imports. +# https://pypi.org/project/isort/ +isort + +# pytest: simple powerful testing with Python +# https://pypi.org/project/pytest/ +pytest + +# Flake8 wrapper to make it nice and configurable +# https://pypi.org/project/flake8/ +flakehell + +# python code static checker +# https://pypi.org/project/pylint/ +pylint + +# Python docstring style checker +# https://pypi.org/project/pydocstyle/ +pydocstyle + +# Python wrapper around invoking shellcheck (https://www.shellcheck.net/) +# https://pypi.org/project/shellcheck-py/ +shellcheck-py + +# A linter for YAML files. +# https://pypi.org/project/yamllint/ +yamllint + +### END MKDOCS TEMPLATE ### diff --git a/requirements.dev.txt b/requirements.dev.txt new file mode 100644 index 0000000..70e576b --- /dev/null +++ b/requirements.dev.txt @@ -0,0 +1,115 @@ +### BEGIN MKDOCS TEMPLATE ### +### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !### +### Modified content will be overwritten when updating.### + +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile requirements.dev.in +# +appdirs==1.4.4 + # via + # black + # virtualenv +astroid==2.5.2 + # via pylint +attrs==20.3.0 + # via pytest +black==20.8b1 + # via -r requirements.dev.in +click==7.1.2 + # via black +colorama==0.4.4 + # via flakehell +distlib==0.3.1 + # via virtualenv +entrypoints==0.3 + # via flakehell +filelock==3.0.12 + # via + # tox + # virtualenv +flake8==3.9.0 + # via flakehell +flakehell==0.9.0 + # via -r requirements.dev.in +iniconfig==1.1.1 + # via pytest +isort==5.8.0 + # via + # -r requirements.dev.in + # pylint +lazy-object-proxy==1.6.0 + # via astroid +mccabe==0.6.1 + # via + # flake8 + # pylint +mypy-extensions==0.4.3 + # via black +packaging==20.9 + # via + # pytest + # tox +pathspec==0.8.1 + # via + # black + # yamllint +pluggy==0.13.1 + # via + # pytest + # tox +py==1.10.0 + # via + # pytest + # tox +pycodestyle==2.7.0 + # via flake8 +pydocstyle==6.0.0 + # via -r requirements.dev.in +pyflakes==2.3.1 + # via flake8 +pygments==2.8.1 + # via flakehell +pylint==2.7.4 + # via -r requirements.dev.in +pyparsing==2.4.7 + # via packaging +pytest==6.2.3 + # via -r requirements.dev.in +pyyaml==5.4.1 + # via yamllint +regex==2021.4.4 + # via black +shellcheck-py==0.7.1.1 + # via -r requirements.dev.in +six==1.15.0 + # via + # tox + # virtualenv +snowballstemmer==2.1.0 + # via pydocstyle +toml==0.10.2 + # via + # black + # flakehell + # pylint + # pytest + # tox +tox==3.23.0 + # via -r requirements.dev.in +typed-ast==1.4.2 + # via black +typing-extensions==3.7.4.3 + # via black +urllib3==1.26.4 + # via flakehell +virtualenv==20.4.3 + # via tox +wrapt==1.12.1 + # via astroid +yamllint==1.26.1 + # via -r requirements.dev.in + +### END MKDOCS TEMPLATE ### diff --git a/requirements.docs.in b/requirements.docs.in new file mode 100644 index 0000000..16f6bc7 --- /dev/null +++ b/requirements.docs.in @@ -0,0 +1,61 @@ +### BEGIN MKDOCS TEMPLATE ### +### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !### +### Modified content will be overwritten when updating.### + +# DOCUMENTATION REQUIREMENTS +# ============================================================ +# DESCRIPTION: +# Requirements to be able to render documentation locally + +# Documentation rendering dependencies +# ------------------------------------------------------------ +# Project documentation with Markdown. +# https://pypi.org/project/mkdocs/ +mkdocs + +# A Material Design theme for MkDocs +# https://pypi.org/project/mkdocs-material/ +mkdocs-material>=7.0 + +# Plugin for adding monorepository support in Mkdocs. +# https://pypi.org/project/mkdocs-monorepo-plugin/ +mkdocs-monorepo-plugin + +# Mkdocs plugin that enables displaying the localized date of the last git +# modification of a markdown file. +# https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/ +mkdocs-git-revision-date-localized-plugin + +# MkDocs plugin to allow clickable sections that lead to an index page +# https://pypi.org/project/mkdocs-section-index/ +mkdocs-section-index + +# Automatic documentation from sources, for MkDocs. +# https://pypi.org/project/mkdocstrings/ +mkdocstrings + +# This is an extension to Python-Markdown which provides an "include" function. +# https://pypi.org/project/markdown-include/ +markdown-include + +# Unleash the power of MkDocs with macros and variables +# https://pypi.org/project/mkdocs-macros-plugin/ +mkdocs-macros-plugin + +# A mkdocs plugin that lets you exclude files or trees. +# https://github.com/apenwarr/mkdocs-exclude +mkdocs-exclude + +# Markdown extension to wrap images in a lightbox. +# https://github.com/g-provost/lightgallery-markdown +git+https://github.com/g-provost/lightgallery-markdown + +# A Mermaid graphs plugin for mkdocs +# https://github.com/fralau/mkdocs-mermaid2-plugin#declaring-the-superfences-extension +mkdocs-mermaid2-plugin + +# Python lib/cli for JSON/YAML schema validation +# https://pypi.org/project/pykwalify/ +pykwalify + +### END MKDOCS TEMPLATE ### diff --git a/requirements.docs.txt b/requirements.docs.txt new file mode 100644 index 0000000..6a46d60 --- /dev/null +++ b/requirements.docs.txt @@ -0,0 +1,162 @@ +### BEGIN MKDOCS TEMPLATE ### +### WARNING, DO NOT UPDATE CONTENT BETWEEN MKDOCS TEMPLATE TAG !### +### Modified content will be overwritten when updating.### + +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile requirements.docs.in +# +astunparse==1.6.3 + # via pytkdocs +babel==2.9.0 + # via mkdocs-git-revision-date-localized-plugin +beautifulsoup4==4.9.3 + # via mkdocs-mermaid2-plugin +certifi==2020.12.5 + # via requests +chardet==4.0.0 + # via requests +click==7.1.2 + # via + # mkdocs + # nltk +docopt==0.6.2 + # via pykwalify +editorconfig==0.12.3 + # via jsbeautifier +future==0.18.2 + # via lunr +gitdb==4.0.7 + # via gitpython +gitpython==3.1.14 + # via mkdocs-git-revision-date-localized-plugin +idna==2.10 + # via requests +jinja2==2.11.3 + # via + # mkdocs + # mkdocs-macros-plugin + # mkdocstrings +joblib==1.0.1 + # via nltk +jsbeautifier==1.13.5 + # via mkdocs-mermaid2-plugin +git+https://github.com/g-provost/lightgallery-markdown + # via -r requirements.docs.in +livereload==2.6.3 + # via mkdocs +lunr[languages]==0.5.8 + # via mkdocs +markdown-include==0.6.0 + # via -r requirements.docs.in +markdown==3.3.4 + # via + # lightgallery + # markdown-include + # mkdocs + # mkdocs-autorefs + # mkdocs-material + # mkdocstrings + # pymdown-extensions +markupsafe==1.1.1 + # via + # jinja2 + # mkdocstrings +mkdocs-autorefs==0.1.1 + # via mkdocstrings +mkdocs-exclude==1.0.2 + # via -r requirements.docs.in +mkdocs-git-revision-date-localized-plugin==0.8 + # via -r requirements.docs.in +mkdocs-macros-plugin==0.5.5 + # via -r requirements.docs.in +mkdocs-material-extensions==1.0.1 + # via mkdocs-material +mkdocs-material==7.1.0 + # via + # -r requirements.docs.in + # mkdocs-macros-plugin + # mkdocs-material-extensions + # mkdocs-mermaid2-plugin +mkdocs-mermaid2-plugin==0.5.1 + # via -r requirements.docs.in +mkdocs-monorepo-plugin==0.4.13 + # via -r requirements.docs.in +mkdocs-section-index==0.2.3 + # via -r requirements.docs.in +mkdocs==1.1.2 + # via + # -r requirements.docs.in + # mkdocs-autorefs + # mkdocs-exclude + # mkdocs-git-revision-date-localized-plugin + # mkdocs-macros-plugin + # mkdocs-material + # mkdocs-mermaid2-plugin + # mkdocs-monorepo-plugin + # mkdocs-section-index + # mkdocstrings +mkdocstrings==0.15.0 + # via -r requirements.docs.in +nltk==3.6.1 + # via lunr +pygments==2.8.1 + # via mkdocs-material +pykwalify==1.8.0 + # via -r requirements.docs.in +pymdown-extensions==8.1.1 + # via + # mkdocs-material + # mkdocs-mermaid2-plugin + # mkdocstrings +python-dateutil==2.8.1 + # via + # mkdocs-macros-plugin + # pykwalify +pytkdocs==0.11.1 + # via mkdocstrings +pytz==2021.1 + # via babel +pyyaml==5.4.1 + # via + # mkdocs + # mkdocs-macros-plugin + # mkdocs-mermaid2-plugin +regex==2021.4.4 + # via nltk +requests==2.25.1 + # via mkdocs-mermaid2-plugin +ruamel.yaml.clib==0.2.2 + # via ruamel.yaml +ruamel.yaml==0.17.4 + # via pykwalify +six==1.15.0 + # via + # astunparse + # jsbeautifier + # livereload + # lunr + # python-dateutil +smmap==4.0.0 + # via gitdb +soupsieve==2.2.1 + # via beautifulsoup4 +termcolor==1.1.0 + # via mkdocs-macros-plugin +tornado==6.1 + # via + # livereload + # mkdocs +tqdm==4.60.0 + # via nltk +urllib3==1.26.4 + # via requests +wheel==0.36.2 + # via astunparse + +# The following packages are considered to be unsafe in a requirements file: +# setuptools + +### END MKDOCS TEMPLATE ### diff --git a/requirements.prod.in b/requirements.prod.in new file mode 120000 index 0000000..62b09d5 --- /dev/null +++ b/requirements.prod.in @@ -0,0 +1 @@ +requirements.docs.in \ No newline at end of file diff --git a/requirements.prod.txt b/requirements.prod.txt new file mode 120000 index 0000000..7f5129a --- /dev/null +++ b/requirements.prod.txt @@ -0,0 +1 @@ +requirements.docs.txt \ No newline at end of file -- GitLab