From 626c3872eac78bf9258cce5eaf4ecec04c16e692 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Wed, 18 Nov 2020 11:53:09 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Create=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 3 + bbbdl/composer.py | 31 ++++ bbbdl/errors.py | 6 - bbbdl/exc.py | 17 ++ bbbdl/resources.py | 111 +++++++++-- bbbdl/tracks.py | 13 ++ bbbdl/urlhandler.py | 13 +- docs/Makefile | 20 ++ docs/make.bat | 35 ++++ docs/source/autodoc/index.rst | 49 +++++ docs/source/conf.py | 85 +++++++++ docs/source/index.rst | 25 +++ poetry.lock | 339 +++++++++++++++++++++++++++++++++- pyproject.toml | 4 + 14 files changed, 721 insertions(+), 30 deletions(-) delete mode 100644 bbbdl/errors.py create mode 100644 bbbdl/exc.py create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/autodoc/index.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/.gitignore b/.gitignore index 9a0e9a5..80c592e 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,6 @@ dist/ # PyCharm ignores .idea/ + +# Docs ignore +/docs/build diff --git a/bbbdl/composer.py b/bbbdl/composer.py index 1a0801f..94f7f77 100644 --- a/bbbdl/composer.py +++ b/bbbdl/composer.py @@ -5,6 +5,21 @@ from .tracks import Tracks def compose_screensharing(meeting: Meeting, width: int, height: int) -> Tracks: + """ + Create a stream composed by: + + * the webcam video + * the deskshare video overlayed on the webcam video + * the webcam audio + + All video streams will be scaled so they all have the same size. + + :param meeting: The meeting to create the stream from. + :param width: The width of the video file. + :param height: The height of the video file. + :return: A :class:`.Tracks` object containing the video and audio tracks. + """ + tracks = Tracks() if meeting.webcams: @@ -18,6 +33,22 @@ def compose_screensharing(meeting: Meeting, width: int, height: int) -> Tracks: def compose_lesson(meeting: Meeting, width: int, height: int) -> Tracks: + """ + Create a stream composed by: + + * the webcam video + * the deskshare video overlayed on the webcam video + * the slides images overlayed on the deskshare video when they are enabled + * the webcam audio + + All video streams will be scaled so they all have the same size. + + :param meeting: The meeting to create the stream from. + :param width: The width of the video file. + :param height: The height of the video file. + :return: A :class:`.Tracks` object containing the video and audio tracks. + """ + tracks = compose_screensharing(meeting, width, height) for shape in meeting.shapes: diff --git a/bbbdl/errors.py b/bbbdl/errors.py deleted file mode 100644 index 91e8e16..0000000 --- a/bbbdl/errors.py +++ /dev/null @@ -1,6 +0,0 @@ -class BBBDLError(Exception): - pass - - -class DownloadError(BBBDLError): - pass diff --git a/bbbdl/exc.py b/bbbdl/exc.py new file mode 100644 index 0000000..ac28ea5 --- /dev/null +++ b/bbbdl/exc.py @@ -0,0 +1,17 @@ +class BBBDLException(Exception): + """ + An :class:`Exception` occoured in bbbdl. + """ + + +class MetadataNotFoundError(BBBDLException): + """ + The metadata (``{base_url}/presentation/{meeting_id}/metadata.xml``) of the specified meeting could not be + retrieved. + """ + + +class SourceNotFoundError(BBBDLException): + """ + The specified url didn't return a successful HTTP status code (200 <= x < 300). + """ diff --git a/bbbdl/resources.py b/bbbdl/resources.py index abd5252..87e10c8 100644 --- a/bbbdl/resources.py +++ b/bbbdl/resources.py @@ -5,34 +5,62 @@ import requests import bs4 import ffmpeg from .urlhandler import playback_to_data +from .exc import MetadataNotFoundError, SourceNotFoundError -class Resource: - def __init__(self, href: str): - self.href: str = href +class Source: + """ + A handler for the splitting of a single video source in multiple input nodes. + + It can be created by specifying an url pointing to a local or remote video. + + It is necessary because the same input source cannot be passed twice to ffmpeg. + """ + + def __init__(self, location: str): + self.href: str = location self._video: Optional[ffmpeg.Stream] = None self._video_count: int = 0 self._audio: Optional[ffmpeg.Stream] = None self._audio_count: int = 0 def __repr__(self): - return f"<{self.__class__.__qualname__} href={self.href}>" + return f"<{self.__class__.__qualname__} href={self.href} | videos={self._video_count} audios" \ + f"={self._audio_count}>" + + def __hash__(self): + return hash(self.href) @classmethod - def check_and_create(cls, href: str) -> Optional[Resource]: - """Check if the resource exists, and create it if it does.""" + def create_from_url(cls, href: str) -> Optional[Source]: + """ + Check if a resource exists at an url, and create a :class:`.Source` from it if it does. + + :return: The created source. + :raises SourceNotFoundError: If the request returned a non-2XX status code. + """ r = requests.head(href) - if not (200 <= r.status_code < 400): - return None - return cls(href=href) + if not (200 <= r.status_code < 300): + raise SourceNotFoundError(f"HEAD for {href} returned {r.status_code}") + return cls(location=href) def get_audio(self) -> ffmpeg.nodes.FilterableStream: + """ + Get an input audio stream. + + :return: The created audio stream. + """ if self._audio is None: self._audio = ffmpeg.input(self.href).audio.asplit() self._audio_count += 1 return self._audio.stream(self._audio_count) def get_video(self) -> ffmpeg.nodes.FilterableStream: + """ + Get an input video stream. + + :return: The created video stream. + """ if self._video is None: self._video = ffmpeg.input(self.href).video.split() self._video_count += 1 @@ -40,29 +68,67 @@ class Resource: @dataclasses.dataclass() -class Shape: - resource: Resource +class Enable: + """ + An object containing two timestamps relative to the start of a meeting. + + They represent the moments when a slide should be displayed and hidden from the screen. + """ + + start: float + end: float + + +@dataclasses.dataclass() +class Slide: + """ + An object representing a single slide from BigBlueButton. + + It contains the :class:`.Source` where the slide can be accessed, and a :class:`list` of :class:`Enable`, + representing the moments when that slide is displayed on screen. + """ + + resource: Source enables: List[Tuple[float, float]] @dataclasses.dataclass() class Meeting: - deskshare: Resource - webcams: Resource - shapes: List[Shape] + """ + An object representing all resources from a BigBlueButton meeting. + """ + + deskshare: Source + "The :class:`.Source` for the desktop-sharing stream." + + webcams: Source + "The :class:`.Source` for the presenter webcam stream." + + shapes: List[Slide] + "A :class:`list` of all the :class:`.Slide` in the presentation." @classmethod def from_base_url(cls, base_url: str, meeting_id: str) -> Meeting: - r = requests.get(f"{base_url}/presentation/{meeting_id}/metadata.xml") - r.raise_for_status() + """ + Create a new :class:`.Meeting` from a BigBlueButton base url and a meeting id. - deskshare = Resource.check_and_create(href=f"{base_url}/presentation/{meeting_id}/deskshare/deskshare.mp4") - webcams = Resource.check_and_create(href=f"{base_url}/presentation/{meeting_id}/video/webcams.mp4") + :param base_url: The base url of the BigBlueButton instance. + :param meeting_id: The id of the meeting to get the resources from. + :return: The created meeting. + :raises MetadataNotFoundError: If the metadata request returned a non-2XX status code. + """ + + r = requests.get(f"{base_url}/presentation/{meeting_id}/metadata.xml") + if not 200 <= r.status_code < 300: + raise MetadataNotFoundError(f"GET for {base_url}/presentation/{meeting_id}/metadata.xml returned {r.status_code}") + + deskshare = Source.create_from_url(href=f"{base_url}/presentation/{meeting_id}/deskshare/deskshare.mp4") + webcams = Source.create_from_url(href=f"{base_url}/presentation/{meeting_id}/video/webcams.mp4") shape_soup = bs4.BeautifulSoup(requests.get(f"{base_url}/presentation/{meeting_id}/shapes.svg").text, "lxml") - shapes: Dict[str, Shape] = {} + shapes: Dict[str, Slide] = {} for tag in shape_soup.find_all("image"): if not tag["in"]: raise ValueError("Tag has no 'in' parameter") @@ -73,7 +139,7 @@ class Meeting: url = tag["xlink:href"] if url not in shapes: - shapes[url] = Shape(resource=Resource(f"{base_url}/presentation/{meeting_id}/{url}"), enables=[]) + shapes[url] = Slide(resource=Source(f"{base_url}/presentation/{meeting_id}/{url}"), enables=[]) shapes[url].enables.append((tag["in"], tag["out"])) return cls( @@ -84,4 +150,9 @@ class Meeting: @classmethod def from_url(cls, url: str) -> Meeting: + """ + Create a new :class:`.Meeting` from any BigBlueButton url by autodetecting the base url and the meeting id. + + .. seealso:: :func:`.playback_to_data` + """ return cls.from_base_url(*playback_to_data(url)) diff --git a/bbbdl/tracks.py b/bbbdl/tracks.py index 42a0929..42344d3 100644 --- a/bbbdl/tracks.py +++ b/bbbdl/tracks.py @@ -3,17 +3,30 @@ import ffmpeg.nodes class Tracks: + """ + A container for video and audio tracks. It starts empty, and more tracks can be added with the :meth:`.overlay` + and :meth:`.amerge` methods. + """ + def __init__(self): self.video: Optional[ffmpeg.nodes.FilterableStream] = None self.audio: Optional[ffmpeg.nodes.FilterableStream] = None def overlay(self, other: ffmpeg.nodes.FilterableStream, **kwargs): + """ + Overlay a new video track. + """ + if self.video is None: self.video = other else: self.video = self.video.overlay(other, **kwargs) def amerge(self, other: ffmpeg.nodes.FilterableStream, **kwargs): + """ + Merge a new audio track. + """ + if self.audio is None: self.audio = other else: diff --git a/bbbdl/urlhandler.py b/bbbdl/urlhandler.py index 6328919..1881a2f 100644 --- a/bbbdl/urlhandler.py +++ b/bbbdl/urlhandler.py @@ -2,11 +2,18 @@ from typing import * import re -split_regex = re.compile(r"^(https?://.+)/playback/presentation/2\.0/playback\.html\?meetingId=([0-9a-f-]+)$") +playback_regex = re.compile(r"^(https?://.+)/playback/presentation/2\.0/playback\.html\?meetingId=([0-9a-f-]+)$") +"The regex used to parse BigBlueButton playback urls." def playback_to_data(url) -> Sequence[str]: - match = split_regex.match(url) + """ + Autodetect the base url and the meeting id from a BigBlueButton playback url. + + :return: The match groups of :data:`.playback_regex`. + :raises ValueError: If the regex doesn't match. + """ + match = playback_regex.match(url) if not match: - raise ValueError("Could not split URL in base_url and meeting_id") + raise ValueError("Could not split URL in base url and meeting id") return match.groups() diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..9534b01 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/autodoc/index.rst b/docs/source/autodoc/index.rst new file mode 100644 index 0000000..fd885fe --- /dev/null +++ b/docs/source/autodoc/index.rst @@ -0,0 +1,49 @@ +API Reference +=========================== + +Welcome to the autogenerated documentation of bbbdl! + +It may be incomplete or outdated, as it is automatically updated. + + +Composer module +--------------- + +.. currentmodule:: bbbdl.composer +.. automodule:: bbbdl.composer + :members: + :undoc-members: + +Resources module +---------------- + +.. currentmodule:: bbbdl.resources +.. automodule:: bbbdl.resources + :members: + :undoc-members: + + +Tracks module +------------- + +.. currentmodule:: bbbdl.tracks +.. automodule:: bbbdl.tracks + :members: + :undoc-members: + + +Url handler module +------------------ + +.. currentmodule:: bbbdl.urlhandler +.. automodule:: bbbdl.urlhandler + :members: + :undoc-members: + +Errors and exceptions +--------------------- + +.. currentmodule:: bbbdl.exc +.. automodule:: bbbdl.exc + :members: + :undoc-members: diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..9227804 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,85 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'bbbdl' +# noinspection PyShadowingBuiltins +copyright = '2020, Stefano Pigozzi, g.minoccari' +author = 'Stefano Pigozzi, g.minoccari' + +# The full version, including alpha/beta/rc tags +release = '1.3.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['Thumbs.db', '.DS_Store'] + +# Print warnings on the page +keep_warnings = True + +# Display more warnings than usual +nitpicky = True + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Intersphinx options ----------------------------------------------------- + +intersphinx_mapping = { + "python": ("https://docs.python.org/3.8", None), + "ffmpeg": ("https://kkroening.github.io/ffmpeg-python/", None) +} + + +# -- Setup function ---------------------------------------------------------- +def setup(app): + app.connect("autodoc-skip-member", skip) + app.add_css_file('royalblue.css') + + +# -- Skip function ----------------------------------------------------------- +def skip(app, what, name: str, obj, would_skip, options): + if name == "__init__" or name == "__getitem__" or name == "__getattr__": + return not bool(obj.__doc__) + return would_skip diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..6851992 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,25 @@ +bbbdl +================================= + +Welcome to the documentation of bbbdl! + +Table of contents +----------------- + +.. toctree:: + :maxdepth: 3 + + autodoc/index + +Useful links +------------ + +* `bbbdl on GitHub `_ + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/poetry.lock b/poetry.lock index 20458c4..ec2be1e 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,3 +1,22 @@ +[[package]] +name = "alabaster" +version = "0.7.12" +description = "A configurable sidebar-enabled Sphinx theme" +category = "dev" +optional = false +python-versions = "*" + +[[package]] +name = "babel" +version = "2.9.0" +description = "Internationalization utilities" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[package.dependencies] +pytz = ">=2015.7" + [[package]] name = "beautifulsoup4" version = "4.9.3" @@ -47,6 +66,14 @@ category = "main" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +[[package]] +name = "docutils" +version = "0.16" +description = "Docutils -- Python Documentation Utilities" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + [[package]] name = "ffmpeg-python" version = "0.2.0" @@ -77,6 +104,28 @@ category = "main" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +[[package]] +name = "imagesize" +version = "1.2.0" +description = "Getting image size from png/jpeg/jpeg2000/gif file" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[[package]] +name = "jinja2" +version = "2.11.2" +description = "A very fast and expressive template engine." +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[package.extras] +i18n = ["Babel (>=0.8)"] + +[package.dependencies] +MarkupSafe = ">=0.23" + [[package]] name = "lxml" version = "4.6.1" @@ -91,6 +140,50 @@ html5 = ["html5lib"] htmlsoup = ["beautifulsoup4"] source = ["Cython (>=0.29.7)"] +[[package]] +name = "markupsafe" +version = "1.1.1" +description = "Safely add untrusted strings to HTML/XML markup." +category = "dev" +optional = false +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" + +[[package]] +name = "packaging" +version = "20.4" +description = "Core utilities for Python packages" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[package.dependencies] +pyparsing = ">=2.0.2" +six = "*" + +[[package]] +name = "pygments" +version = "2.7.2" +description = "Pygments is a syntax highlighting package written in Python." +category = "dev" +optional = false +python-versions = ">=3.5" + +[[package]] +name = "pyparsing" +version = "2.4.7" +description = "Python parsing module" +category = "dev" +optional = false +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" + +[[package]] +name = "pytz" +version = "2020.4" +description = "World timezone definitions, modern and historical" +category = "dev" +optional = false +python-versions = "*" + [[package]] name = "requests" version = "2.25.0" @@ -109,6 +202,22 @@ chardet = ">=3.0.2,<4" idna = ">=2.5,<3" urllib3 = ">=1.21.1,<1.27" +[[package]] +name = "six" +version = "1.15.0" +description = "Python 2 and 3 compatibility utilities" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" + +[[package]] +name = "snowballstemmer" +version = "2.0.0" +description = "This package provides 26 stemmers for 25 languages generated from Snowball algorithms." +category = "dev" +optional = false +python-versions = "*" + [[package]] name = "soupsieve" version = "2.0.1" @@ -118,6 +227,123 @@ optional = false python-versions = ">=3.5" marker = "python_version >= \"3.0\"" +[[package]] +name = "sphinx" +version = "3.3.1" +description = "Python documentation generator" +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +docs = ["sphinxcontrib-websupport"] +lint = ["flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.790)", "docutils-stubs"] +test = ["pytest", "pytest-cov", "html5lib", "typed-ast", "cython"] + +[package.dependencies] +alabaster = ">=0.7,<0.8" +babel = ">=1.3" +colorama = ">=0.3.5" +docutils = ">=0.12" +imagesize = "*" +Jinja2 = ">=2.3" +packaging = "*" +Pygments = ">=2.0" +requests = ">=2.5.0" +setuptools = "*" +snowballstemmer = ">=1.1" +sphinxcontrib-applehelp = "*" +sphinxcontrib-devhelp = "*" +sphinxcontrib-htmlhelp = "*" +sphinxcontrib-jsmath = "*" +sphinxcontrib-qthelp = "*" +sphinxcontrib-serializinghtml = "*" + +[[package]] +name = "sphinx-rtd-theme" +version = "0.5.0" +description = "Read the Docs theme for Sphinx" +category = "dev" +optional = false +python-versions = "*" + +[package.extras] +dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] + +[package.dependencies] +sphinx = "*" + +[[package]] +name = "sphinxcontrib-applehelp" +version = "1.0.2" +description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-devhelp" +version = "1.0.2" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-htmlhelp" +version = "1.0.3" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest", "html5lib"] + +[[package]] +name = "sphinxcontrib-jsmath" +version = "1.0.1" +description = "A sphinx extension which renders display math in HTML via JavaScript" +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +test = ["pytest", "flake8", "mypy"] + +[[package]] +name = "sphinxcontrib-qthelp" +version = "1.0.3" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-serializinghtml" +version = "1.1.4" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + [[package]] name = "urllib3" version = "1.26.2" @@ -134,9 +360,17 @@ socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7,<2.0)"] [metadata] lock-version = "1.0" python-versions = "^3.8" -content-hash = "dfac38187ca5aaf0c35d805a4d1a237b208f4f0883270961a27041816554796b" +content-hash = "a6cba87e90573b2ee09b0b1f0b40d39d7051ee3ebb8c9c605035fe03c1326530" [metadata.files] +alabaster = [ + {file = "alabaster-0.7.12-py2.py3-none-any.whl", hash = "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359"}, + {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"}, +] +babel = [ + {file = "Babel-2.9.0-py2.py3-none-any.whl", hash = "sha256:9d35c22fcc79893c3ecc85ac4a56cde1ecf3f19c540bba0922308a6c06ca6fa5"}, + {file = "Babel-2.9.0.tar.gz", hash = "sha256:da031ab54472314f210b0adcff1588ee5d1d1d0ba4dbd07b94dba82bde791e05"}, +] beautifulsoup4 = [ {file = "beautifulsoup4-4.9.3-py2-none-any.whl", hash = "sha256:4c98143716ef1cb40bf7f39a8e3eec8f8b009509e74904ba3a7b315431577e35"}, {file = "beautifulsoup4-4.9.3-py3-none-any.whl", hash = "sha256:fff47e031e34ec82bf17e00da8f592fe7de69aeea38be00523c04623c04fb666"}, @@ -158,6 +392,10 @@ colorama = [ {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, ] +docutils = [ + {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"}, + {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"}, +] ffmpeg-python = [ {file = "ffmpeg-python-0.2.0.tar.gz", hash = "sha256:65225db34627c578ef0e11c8b1eb528bb35e024752f6f10b78c011f6f64c4127"}, {file = "ffmpeg_python-0.2.0-py3-none-any.whl", hash = "sha256:ac441a0404e053f8b6a1113a77c0f452f1cfc62f6344a769475ffdc0f56c23c5"}, @@ -169,6 +407,14 @@ idna = [ {file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"}, {file = "idna-2.10.tar.gz", hash = "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6"}, ] +imagesize = [ + {file = "imagesize-1.2.0-py2.py3-none-any.whl", hash = "sha256:6965f19a6a2039c7d48bca7dba2473069ff854c36ae6f19d2cde309d998228a1"}, + {file = "imagesize-1.2.0.tar.gz", hash = "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1"}, +] +jinja2 = [ + {file = "Jinja2-2.11.2-py2.py3-none-any.whl", hash = "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035"}, + {file = "Jinja2-2.11.2.tar.gz", hash = "sha256:89aab215427ef59c34ad58735269eb58b1a5808103067f7bb9d5836c651b3bb0"}, +] lxml = [ {file = "lxml-4.6.1-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:4b7572145054330c8e324a72d808c8c8fbe12be33368db28c39a255ad5f7fb51"}, {file = "lxml-4.6.1-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:302160eb6e9764168e01d8c9ec6becddeb87776e81d3fcb0d97954dd51d48e0a"}, @@ -208,14 +454,105 @@ lxml = [ {file = "lxml-4.6.1-cp39-cp39-win_amd64.whl", hash = "sha256:7ecaef52fd9b9535ae5f01a1dd2651f6608e4ec9dc136fc4dfe7ebe3c3ddb230"}, {file = "lxml-4.6.1.tar.gz", hash = "sha256:c152b2e93b639d1f36ec5a8ca24cde4a8eefb2b6b83668fcd8e83a67badcb367"}, ] +markupsafe = [ + {file = "MarkupSafe-1.1.1-cp27-cp27m-macosx_10_6_intel.whl", hash = "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-win32.whl", hash = "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-win_amd64.whl", hash = "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e"}, + {file = "MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f"}, + {file = "MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-macosx_10_6_intel.whl", hash = "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-manylinux1_i686.whl", hash = "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-manylinux1_x86_64.whl", hash = "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-win32.whl", hash = "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-win_amd64.whl", hash = "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-macosx_10_6_intel.whl", hash = "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-win32.whl", hash = "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-win_amd64.whl", hash = "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-macosx_10_6_intel.whl", hash = "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-win32.whl", hash = "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-macosx_10_6_intel.whl", hash = "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-win32.whl", hash = "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-win_amd64.whl", hash = "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-win32.whl", hash = "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-win_amd64.whl", hash = "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be"}, + {file = "MarkupSafe-1.1.1.tar.gz", hash = "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b"}, +] +packaging = [ + {file = "packaging-20.4-py2.py3-none-any.whl", hash = "sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181"}, + {file = "packaging-20.4.tar.gz", hash = "sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8"}, +] +pygments = [ + {file = "Pygments-2.7.2-py3-none-any.whl", hash = "sha256:88a0bbcd659fcb9573703957c6b9cff9fab7295e6e76db54c9d00ae42df32773"}, + {file = "Pygments-2.7.2.tar.gz", hash = "sha256:381985fcc551eb9d37c52088a32914e00517e57f4a21609f48141ba08e193fa0"}, +] +pyparsing = [ + {file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"}, + {file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"}, +] +pytz = [ + {file = "pytz-2020.4-py2.py3-none-any.whl", hash = "sha256:5c55e189b682d420be27c6995ba6edce0c0a77dd67bfbe2ae6607134d5851ffd"}, + {file = "pytz-2020.4.tar.gz", hash = "sha256:3e6b7dd2d1e0a59084bcee14a17af60c5c562cdc16d828e8eba2e683d3a7e268"}, +] requests = [ {file = "requests-2.25.0-py2.py3-none-any.whl", hash = "sha256:e786fa28d8c9154e6a4de5d46a1d921b8749f8b74e28bde23768e5e16eece998"}, {file = "requests-2.25.0.tar.gz", hash = "sha256:7f1a0b932f4a60a1a65caa4263921bb7d9ee911957e0ae4a23a6dd08185ad5f8"}, ] +six = [ + {file = "six-1.15.0-py2.py3-none-any.whl", hash = "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced"}, + {file = "six-1.15.0.tar.gz", hash = "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259"}, +] +snowballstemmer = [ + {file = "snowballstemmer-2.0.0-py2.py3-none-any.whl", hash = "sha256:209f257d7533fdb3cb73bdbd24f436239ca3b2fa67d56f6ff88e86be08cc5ef0"}, + {file = "snowballstemmer-2.0.0.tar.gz", hash = "sha256:df3bac3df4c2c01363f3dd2cfa78cce2840a79b9f1c2d2de9ce8d31683992f52"}, +] soupsieve = [ {file = "soupsieve-2.0.1-py3-none-any.whl", hash = "sha256:1634eea42ab371d3d346309b93df7870a88610f0725d47528be902a0d95ecc55"}, {file = "soupsieve-2.0.1.tar.gz", hash = "sha256:a59dc181727e95d25f781f0eb4fd1825ff45590ec8ff49eadfd7f1a537cc0232"}, ] +sphinx = [ + {file = "Sphinx-3.3.1-py3-none-any.whl", hash = "sha256:d4e59ad4ea55efbb3c05cde3bfc83bfc14f0c95aa95c3d75346fcce186a47960"}, + {file = "Sphinx-3.3.1.tar.gz", hash = "sha256:1e8d592225447104d1172be415bc2972bd1357e3e12fdc76edf2261105db4300"}, +] +sphinx-rtd-theme = [ + {file = "sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl", hash = "sha256:373413d0f82425aaa28fb288009bf0d0964711d347763af2f1b65cafcb028c82"}, + {file = "sphinx_rtd_theme-0.5.0.tar.gz", hash = "sha256:22c795ba2832a169ca301cd0a083f7a434e09c538c70beb42782c073651b707d"}, +] +sphinxcontrib-applehelp = [ + {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, + {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"}, +] +sphinxcontrib-devhelp = [ + {file = "sphinxcontrib-devhelp-1.0.2.tar.gz", hash = "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4"}, + {file = "sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e"}, +] +sphinxcontrib-htmlhelp = [ + {file = "sphinxcontrib-htmlhelp-1.0.3.tar.gz", hash = "sha256:e8f5bb7e31b2dbb25b9cc435c8ab7a79787ebf7f906155729338f3156d93659b"}, + {file = "sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:3c0bc24a2c41e340ac37c85ced6dafc879ab485c095b1d65d2461ac2f7cca86f"}, +] +sphinxcontrib-jsmath = [ + {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, + {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, +] +sphinxcontrib-qthelp = [ + {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"}, + {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"}, +] +sphinxcontrib-serializinghtml = [ + {file = "sphinxcontrib-serializinghtml-1.1.4.tar.gz", hash = "sha256:eaa0eccc86e982a9b939b2b82d12cc5d013385ba5eadcc7e4fed23f4405f77bc"}, + {file = "sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl", hash = "sha256:f242a81d423f59617a8e5cf16f5d4d74e28ee9a66f9e5b637a18082991db5a9a"}, +] urllib3 = [ {file = "urllib3-1.26.2-py2.py3-none-any.whl", hash = "sha256:d8ff90d979214d7b4f8ce956e80f4028fc6860e4431f731ea4a8c08f23f99473"}, {file = "urllib3-1.26.2.tar.gz", hash = "sha256:19188f96923873c92ccb987120ec4acaa12f0461fa9ce5d3d0772bc965a39e08"}, diff --git a/pyproject.toml b/pyproject.toml index 57c295a..59f4efd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,6 +20,10 @@ colorama = "^0.4.4" [tool.poetry.scripts] bbbdl = 'bbbdl.__main__:main' + +[tool.poetry.dev-dependencies] +sphinx = "^3.3.1" +sphinx_rtd_theme = "^0.5.0" [build-system] requires = ["poetry>=0.12"] build-backend = "poetry.masonry.api"