sc-oa 0.7.0.15__py3-none-any.whl → 0.7.0.16__py3-none-any.whl

{sc_oa-0.7.0.15.dist-info → sc_oa-0.7.0.16.dist-info}/METADATA

@@ -1,37 +1,36 @@
-Metadata-Version: 2.4
-Name: sc-oa
-Version: 0.7.0.15
-Summary: Fork of the OpenAPI (fka Swagger) spec renderer for Sphinx
-Home-page: https://github.com/olivier-heurtier/sphinxcontrib-openapi/tree/mymaster
-Author: Ihor Kalnytskyi
-Olivier Heurtier
-Author-email: ihor@kalnytskyi.com
-License: BSD
-Classifier: Topic :: Documentation
-Classifier: Topic :: Documentation :: Sphinx
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Framework :: Sphinx
-Classifier: Framework :: Sphinx :: Extension
-Requires-Python: >=3.8
-License-File: LICENSE
-Requires-Dist: sphinx
-Requires-Dist: sphinxcontrib-httpdomain
-Requires-Dist: PyYAML
-Requires-Dist: jsonschema
-Requires-Dist: m2r2
-Requires-Dist: picobox
-Requires-Dist: deepmerge
-Requires-Dist: setuptools
-Dynamic: license-file
+Metadata-Version: 2.4
+Name: sc-oa
+Version: 0.7.0.16
+Summary: Fork of the OpenAPI (fka Swagger) spec renderer for Sphinx
+Home-page: https://github.com/olivier-heurtier/sphinxcontrib-openapi/tree/mymaster
+Author: Olivier Heurtier
+Author-email: olivier.heurtier@github.com
+License: BSD
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: sphinx
+Requires-Dist: sphinxcontrib-httpdomain
+Requires-Dist: PyYAML
+Requires-Dist: jsonschema
+Requires-Dist: m2r2
+Requires-Dist: picobox
+Requires-Dist: deepmerge
+Requires-Dist: setuptools
+Dynamic: license-file

sc_oa-0.7.0.16.dist-info/RECORD

@@ -0,0 +1,26 @@
+sc_oa-0.7.0.16.dist-info/licenses/LICENSE,sha256=Fe9eBZy-tUN-UOMSVfcr4c-MWpuWa4gTKTqH-kSeck4,1319
+sphinxcontrib/__init__.py,sha256=Es10gRADmbGSJZnYYmhfgA_2QzHQDmhj0IAft3kS1Og,259
+sphinxcontrib/openapi/__init__.py,sha256=x8cvrnXGqjZSc62nkeZC0KdCcCSXQY8uxv1kFhrPM18,3088
+sphinxcontrib/openapi/__main__.py,sha256=cp8p7qGn8nH2W_aeD9sMTuqPwLV3ys8DtLYZnyF29pY,2436
+sphinxcontrib/openapi/_lib2to3.py,sha256=mU2Dx78xEyiz0cfcj3R9eqiwHbCfspK5cDJ5ZwwQdA4,13624
+sphinxcontrib/openapi/directive.py,sha256=J4T0n_KkM6SB1Mr9GeYCVqWZNp3BMSjEnVvLvwj8CoM,2059
+sphinxcontrib/openapi/openapi20.py,sha256=FDdlcRIYKCynOZUjxQNoE8lCFRrZinmYu1khz8D18ZU,8984
+sphinxcontrib/openapi/openapi30.py,sha256=tW5pZoP-lR8ZUrwCsKDB_DXdOzoMdyYL1Irjd6mwdBM,29132
+sphinxcontrib/openapi/schema_utils.py,sha256=pxdB5qSTAtiCFmmF04R0zlOOG-Dxi98qwrA2uLZcNXA,4446
+sphinxcontrib/openapi/utils.py,sha256=oRWNDb_5KWTXOVblFgvrLvmGATae8C7PYvk1xc464vY,4343
+sphinxcontrib/openapi/locale/openapi.pot,sha256=sGo7dIRUUS6Ne4MRIU7PCphOoQG1AORgZhwwpD0nRfo,3831
+sphinxcontrib/openapi/locale/es_ES/LC_MESSAGES/openapi.mo,sha256=qdW6yFaSVB_BsexvwM33U8X12yoHikgaI8N7a4U_gI4,1919
+sphinxcontrib/openapi/locale/es_ES/LC_MESSAGES/openapi.po,sha256=dB6_HK0ubCauj1LZbs-zz0NNcPkm4eqKIuxZtqD71WU,4357
+sphinxcontrib/openapi/locale/fr_FR/LC_MESSAGES/openapi.mo,sha256=YS2uZZZ4bHpDXJmShv33NZhtIWcir9-qERusNDR-vqY,1956
+sphinxcontrib/openapi/locale/fr_FR/LC_MESSAGES/openapi.po,sha256=_rpbU9BhwTI2vXFcgj-BdiC-5LhUphYvHtoU1jPHT4Y,4400
+sphinxcontrib/openapi/renderers/__init__.py,sha256=8hdY-sLK5kDbOL8Tqe55xEBphPFXVCNj6eUA3lTvD8s,408
+sphinxcontrib/openapi/renderers/_description.py,sha256=FAklhEaMksCYU5bno3SO0RuQCcwVTXbqPmPN3PrRlTM,702
+sphinxcontrib/openapi/renderers/_httpdomain.py,sha256=qx6pIVQF2BKWjrL1YOap1_2odtLAqk5SeuktofdOMRQ,24546
+sphinxcontrib/openapi/renderers/_httpdomain_old.py,sha256=aiWafD8LdRmCtG6ewkU3xF-P1oWxxYxUNzdcUFW4hB4,2632
+sphinxcontrib/openapi/renderers/_model.py,sha256=yoU265jAgkiW_Ew4EFiWuzA8Q56AsmYa4HBODJDA2bw,15441
+sphinxcontrib/openapi/renderers/_toc.py,sha256=0cVLyKJBcu4ULkiBdlQ-oMBWV4DVCVM5-BgT07xG0Fc,1478
+sphinxcontrib/openapi/renderers/abc.py,sha256=-irO9yVoHeygaMieq4DZMmWD0B5DkDu2mKuenGYopTI,1485
+sc_oa-0.7.0.16.dist-info/METADATA,sha256=-slypLDLtwQjPS6hf10JVBTE1Fwic_tZUAmPrlV-ORM,1360
+sc_oa-0.7.0.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sc_oa-0.7.0.16.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sc_oa-0.7.0.16.dist-info/RECORD,,

{sc_oa-0.7.0.15.dist-info → sc_oa-0.7.0.16.dist-info}/licenses/LICENSE

@@ -1,23 +1,23 @@
-Copyright (c) 2016, Igor Kalnitsky <igor@kalnitsky.org>.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) 2016, Igor Kalnitsky <igor@kalnitsky.org>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sphinxcontrib/__init__.py

@@ -1,10 +1,10 @@
-"""
-    sphinxcontrib
-    ~~~~~~~~~~~~~
-
-    This package is a namespace package that contains all extensions
-    distributed in the ``sphinx-contrib`` distribution.
-
-    :copyright: (c) 2016 by Igor Kalnitsky.
-    :license: BSD, see LICENSE for details.
-"""
+"""
+    sphinxcontrib
+    ~~~~~~~~~~~~~
+
+    This package is a namespace package that contains all extensions
+    distributed in the ``sphinx-contrib`` distribution.
+
+    :copyright: (c) 2016 by Igor Kalnitsky.
+    :license: BSD, see LICENSE for details.
+"""

sphinxcontrib/openapi/__init__.py

@@ -1,93 +1,93 @@
-"""get_distribution
-    sphinxcontrib.openapi
-    ---------------------
-
-    The OpenAPI spec renderer for Sphinx. It's a new way to document your
-    RESTful API. Based on ``sphinxcontrib-httpdomain``.
-
-    :copyright: (c) 2016, Ihor Kalnytskyi.
-    :license: BSD, see LICENSE for details.
-"""
-
-import os
-from importlib.metadata import distribution, PackageNotFoundError
-from sphinxcontrib.openapi import renderers, directive
-from sphinx.domains import Domain
-import yaml
-from docutils import nodes
-
-try:
-    __version__ = distribution(__name__).version
-except PackageNotFoundError:
-    # package is not installed
-    __version__ = None
-
-
-_DEFAULT_RENDERER_NAME = "httpdomain:old"
-
-
-def oasversion_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
-    fn = text
-    env = inliner.document.settings.env
-    rel_fn, fn = env.relfn2path(fn)
-    y = yaml.load(open(fn, 'r').read(), Loader=yaml.FullLoader)
-    s = y['info']['version']
-    retnode = nodes.inline(text=s, role=typ.lower(), classes=[typ])
-    return [retnode], []
-
-
-class OpenAPIDomain(Domain):
-    name = 'openapi'
-    label = 'OpenAPI Documentation'
-
-    directives = {
-        'httpdomain:old': directive.create_directive_from_renderer(
-            renderers.HttpdomainOldRenderer),
-        'httpdomain': directive.create_directive_from_renderer(renderers.HttpdomainRenderer),
-        'model': directive.create_directive_from_renderer(renderers.ModelRenderer),
-        'toc': directive.create_directive_from_renderer(renderers.TocRenderer),
-        'description': directive.create_directive_from_renderer(renderers.DescriptionRenderer),
-    }
-
-    roles = {
-        'version': oasversion_role
-    }
-
-
-def setup(app):
-    app.add_config_value("openapi_default_renderer", _DEFAULT_RENDERER_NAME, "html")
-    app.add_config_value("openapi_renderers", {}, "html")
-
-    package_dir = os.path.abspath(os.path.dirname(__file__))
-    locale_dir = os.path.join(package_dir, 'locale')
-    app.add_message_catalog('openapi', locale_dir)
-
-    from sphinxcontrib import httpdomain
-
-    for idx, fieldtype in enumerate(httpdomain.HTTPResource.doc_field_types):
-        if fieldtype.name == 'requestheader':
-            httpdomain.HTTPResource.doc_field_types[idx] = httpdomain.TypedField(
-                fieldtype.name,
-                label=fieldtype.label,
-                names=fieldtype.names,
-                typerolename='header',
-                typenames=('reqheadertype', ),
-            )
-
-        if fieldtype.name == 'responseheader':
-            httpdomain.HTTPResource.doc_field_types[idx] = httpdomain.TypedField(
-                fieldtype.name,
-                label=fieldtype.label,
-                names=fieldtype.names,
-                typerolename='header',
-                typenames=('resheadertype', ),
-            )
-
-    app.setup_extension("sphinxcontrib.httpdomain")
-    app.add_domain(OpenAPIDomain)
-    app.add_directive(
-        "openapi",
-        directive.create_directive_from_renderer(renderers.HttpdomainOldRenderer)
-    )
-
-    return {"version": __version__, "parallel_read_safe": True}
+"""get_distribution
+    sphinxcontrib.openapi
+    ---------------------
+
+    The OpenAPI spec renderer for Sphinx. It's a new way to document your
+    RESTful API. Based on ``sphinxcontrib-httpdomain``.
+
+    :copyright: (c) 2016, Ihor Kalnytskyi.
+    :license: BSD, see LICENSE for details.
+"""
+
+import os
+from importlib.metadata import distribution, PackageNotFoundError
+from sphinxcontrib.openapi import renderers, directive
+from sphinx.domains import Domain
+import yaml
+from docutils import nodes
+
+try:
+    __version__ = distribution(__name__).version
+except PackageNotFoundError:
+    # package is not installed
+    __version__ = None
+
+
+_DEFAULT_RENDERER_NAME = "httpdomain:old"
+
+
+def oasversion_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
+    fn = text
+    env = inliner.document.settings.env
+    rel_fn, fn = env.relfn2path(fn)
+    y = yaml.load(open(fn, 'r').read(), Loader=yaml.FullLoader)
+    s = y['info']['version']
+    retnode = nodes.inline(text=s, role=typ.lower(), classes=[typ])
+    return [retnode], []
+
+
+class OpenAPIDomain(Domain):
+    name = 'openapi'
+    label = 'OpenAPI Documentation'
+
+    directives = {
+        'httpdomain:old': directive.create_directive_from_renderer(
+            renderers.HttpdomainOldRenderer),
+        'httpdomain': directive.create_directive_from_renderer(renderers.HttpdomainRenderer),
+        'model': directive.create_directive_from_renderer(renderers.ModelRenderer),
+        'toc': directive.create_directive_from_renderer(renderers.TocRenderer),
+        'description': directive.create_directive_from_renderer(renderers.DescriptionRenderer),
+    }
+
+    roles = {
+        'version': oasversion_role
+    }
+
+
+def setup(app):
+    app.add_config_value("openapi_default_renderer", _DEFAULT_RENDERER_NAME, "html")
+    app.add_config_value("openapi_renderers", {}, "html")
+
+    package_dir = os.path.abspath(os.path.dirname(__file__))
+    locale_dir = os.path.join(package_dir, 'locale')
+    app.add_message_catalog('openapi', locale_dir)
+
+    from sphinxcontrib import httpdomain
+
+    for idx, fieldtype in enumerate(httpdomain.HTTPResource.doc_field_types):
+        if fieldtype.name == 'requestheader':
+            httpdomain.HTTPResource.doc_field_types[idx] = httpdomain.TypedField(
+                fieldtype.name,
+                label=fieldtype.label,
+                names=fieldtype.names,
+                typerolename='header',
+                typenames=('reqheadertype', ),
+            )
+
+        if fieldtype.name == 'responseheader':
+            httpdomain.HTTPResource.doc_field_types[idx] = httpdomain.TypedField(
+                fieldtype.name,
+                label=fieldtype.label,
+                names=fieldtype.names,
+                typerolename='header',
+                typenames=('resheadertype', ),
+            )
+
+    app.setup_extension("sphinxcontrib.httpdomain")
+    app.add_domain(OpenAPIDomain)
+    app.add_directive(
+        "openapi",
+        directive.create_directive_from_renderer(renderers.HttpdomainOldRenderer)
+    )
+
+    return {"version": __version__, "parallel_read_safe": True}

sphinxcontrib/openapi/__main__.py

@@ -1,86 +1,86 @@
-import argparse
-import logging
-
-from sphinxcontrib.openapi import directive, renderers
-
-
-def main():
-    parser = argparse.ArgumentParser(
-        prog='oas2rst',
-        description='Export OpenAPI Specification files to reStructuredText \
-            files')
-    parser.add_argument(
-        "-l", "--level",
-        action='store',
-        default=logging.INFO,
-        dest='level',
-        help="Logging level")
-    parser.add_argument(
-        "-e", "--encoding",
-        action='store',
-        default="UTF-8",
-        dest='encoding',
-        help="Source file encoding")
-    parser.add_argument(
-        "-p", "--paths",
-        action='append',
-        dest='paths',
-        help="Endpoints to be rendered")
-    parser.add_argument(
-        "-x", "--examples",
-        action='store_true',
-        dest='examples',
-        help="Include examples")
-    parser.add_argument(
-        "--group-examples",
-        action='store_true',
-        dest='group_examples',
-        help="Group examples after the operation description")
-    parser.add_argument(
-        "-E", "--entities",
-        action='store_true',
-        dest='entities',
-        help="Include links to entities")
-    parser.add_argument(
-        "-g", "--group",
-        action='store_true',
-        dest='group',
-        help="Group paths by tag")
-    parser.add_argument(
-        "-i", "--input",
-        dest='input',
-        required=True,
-        help="Input file")
-    parser.add_argument(
-        "-o", "--output",
-        type=argparse.FileType('w'),
-        required=True,
-        dest='output',
-        help="Output file")
-
-    options = parser.parse_args()
-    logging.getLogger().setLevel(options.level)
-
-    openapi_options = {}
-    if options.paths:
-        openapi_options['paths'] = options.paths
-    if options.examples:
-        openapi_options['examples'] = True
-    if options.group_examples:
-        openapi_options['group_examples'] = True
-    if options.entities:
-        openapi_options['entities'] = True
-    if options.group:
-        openapi_options['group'] = True
-
-    openapi_options.setdefault('uri', 'file://%s' % options.input)
-    spec = directive._get_spec(options.input, options.encoding)
-    renderer = renderers.HttpdomainOldRenderer(None, openapi_options)
-
-    for line in renderer.render_restructuredtext_markup(spec):
-        options.output.write(line+'\n')
-        logging.debug(line)
-
-
-if __name__ == '__main__':
-    main()
+import argparse
+import logging
+
+from sphinxcontrib.openapi import directive, renderers
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='oas2rst',
+        description='Export OpenAPI Specification files to reStructuredText \
+            files')
+    parser.add_argument(
+        "-l", "--level",
+        action='store',
+        default=logging.INFO,
+        dest='level',
+        help="Logging level")
+    parser.add_argument(
+        "-e", "--encoding",
+        action='store',
+        default="UTF-8",
+        dest='encoding',
+        help="Source file encoding")
+    parser.add_argument(
+        "-p", "--paths",
+        action='append',
+        dest='paths',
+        help="Endpoints to be rendered")
+    parser.add_argument(
+        "-x", "--examples",
+        action='store_true',
+        dest='examples',
+        help="Include examples")
+    parser.add_argument(
+        "--group-examples",
+        action='store_true',
+        dest='group_examples',
+        help="Group examples after the operation description")
+    parser.add_argument(
+        "-E", "--entities",
+        action='store_true',
+        dest='entities',
+        help="Include links to entities")
+    parser.add_argument(
+        "-g", "--group",
+        action='store_true',
+        dest='group',
+        help="Group paths by tag")
+    parser.add_argument(
+        "-i", "--input",
+        dest='input',
+        required=True,
+        help="Input file")
+    parser.add_argument(
+        "-o", "--output",
+        type=argparse.FileType('w'),
+        required=True,
+        dest='output',
+        help="Output file")
+
+    options = parser.parse_args()
+    logging.getLogger().setLevel(options.level)
+
+    openapi_options = {}
+    if options.paths:
+        openapi_options['paths'] = options.paths
+    if options.examples:
+        openapi_options['examples'] = True
+    if options.group_examples:
+        openapi_options['group_examples'] = True
+    if options.entities:
+        openapi_options['entities'] = True
+    if options.group:
+        openapi_options['group'] = True
+
+    openapi_options.setdefault('uri', 'file://%s' % options.input)
+    spec = directive._get_spec(options.input, options.encoding)
+    renderer = renderers.HttpdomainOldRenderer(None, openapi_options)
+
+    for line in renderer.render_restructuredtext_markup(spec):
+        options.output.write(line+'\n')
+        logging.debug(line)
+
+
+if __name__ == '__main__':
+    main()