swaggerizer 0.1.1__tar.gz

swaggerizer-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

swaggerizer-0.1.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include swaggerizer/files *

swaggerizer-0.1.1/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: swaggerizer
+Version: 0.1.1
+Summary: CLI tool to modularize and maintain OpenAPI docs
+Author-email: JR Halterlein <jrhalterlein@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://www.swaggerizer.com
+Project-URL: Documentation, https://docs.swaggerizer.com
+Project-URL: Source, https://github.com/jrhalterlein/swaggerizer
+Keywords: openapi,swagger,swaggerizer,cli,docs,modularize
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ruamel.yaml<0.19,>=0.18
+Requires-Dist: PyYAML>=6.0
+Dynamic: license-file
+
+# Swaggerizer
+
+**A lightweight CLI tool to modularize, maintain, and publish OpenAPI docs.**
+
+Swaggerizer takes a practical approach to OpenAPI docs management, in the sweet spot between too monolithic or too granular. It breaks up OpenAPI spec files by functional groups and uses a simple make-based system to reassemble them.
+
+The Swaggerizer project structure makes it easy for a single writer to build and maintain OpenAPI docs, or for a team of writers to collaborate using a docs-as-code approach.
+
+Swaggerizing your OpenAPI docs is _risk free_. It creates a separate source folder with the modularized project files, so you can test it out before committing to anything. Give it a try!
+
+## Features
+
+- Create a modular OpenAPI project from a single OpenAPI YAML file:
+   - Modularize an existing OpenAPI file, or start a new project from the default Petstore file
+   - Use make to test and reassemble a single OpenAPI file out of the project/source files 
+   - Project files are set up in the **openapi_src** sub-directory, with the following structure:
+      ```
+      openapi_src/
+      ├── 0_intro/        # Basic info, metadata, and tags
+      ├── 1_endpoints/    # Endpoint descriptions grouped by tag (one file per tag)
+      ├── 2_components/   # Reusable objects (schemas, parameters, examples, etc.)
+      ├── 3_misc/         # Additional top-level sections not categorized above
+      └── makefile        # Custom makefile to generate the final OpenAPI file
+      ```
+- Other features:
+   - Convert OpenAPI files from JSON → YAML or YAML → JSON 
+   - Validate YAML/JSON file formats
+   - Export an OpenAPI YAML file as HTML for publishing
+
+## Prerequisites
+
+- Python 3.8 or later
+- make
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install swaggerizer
+```
+
+Verify the installation:
+
+```bash
+swgrzr --help
+```
+
+## Quick start
+
+Create a new swaggerizer project from your existing **openapi.yaml** file:
+
+```bash
+swgrzr create -i openapi.yaml
+```
+
+Create a new swaggerizer project from the default Petstore file:
+
+```bash
+swgrzr create 
+```
+
+Build a testing version of the complete OpenAPI file from source:
+
+```bash
+cd openapi_src
+make
+```
+
+Copy the current testing version of the OpenAPI file into the parent directory for publishing:
+
+```bash
+make final-build
+```
+
+Export the OpenAPI YAML file as HTML:
+
+```bash
+swgrzr export -i openapi.yaml
+```
+
+## CLI usage
+
+### Syntax
+
+```
+swgrzr OPERATION [options]
+```
+
+### Available operations
+
+| Operation   | Description |
+|-------------|-------------|
+| create      | Create a new modularized project from an OpenAPI YAML file. |
+| export      | Export the input OpenAPI YAML as a rendered HTML document. |
+| json2yaml   | Convert an OpenAPI JSON file to YAML. |
+| yaml2json   | Convert an OpenAPI YAML file to JSON. |
+| validate    | Validate basic JSON or YAML structure. |
+
+### Common options
+
+| Option            | Description |
+|------------------|-------------|
+| -i, --input      | Input file path. Defaults vary by operation. |
+| -o, --output     | Output file path. Defaults vary by operation. |
+| -t, --type       | Input type for validation (`json`, `yaml`). |
+
+## How it works
+
+To create a modularized OpenAPI docs project, swaggerizer:
+
+1. Loads the source OpenAPI YAML.
+2. Detects the OpenAPI version (`v2` or `v3`).
+3. Extracts and groups the OpenAPI sections.
+4. Generates the modular project source directory.
+5. Adds the makefile to rebuild the spec.
+
+## Source code overview
+
+```
+swaggerizer/          # Metadata and packaging
+├── swaggerizer/      # Python app source 
+│   ├── cli.py        # CLI entry point
+│   ├── files/        # Default assets
+│   └── helpers/      # Helper modules
+```
+
+## How to help
+
+Feedback is appreciated! 
+
+Please:
+
+- Report bugs or unexpected behavior.
+- Propose enhancements to CLI commands or options.
+
+To contribute:
+
+1. Fork the swaggerizer repo.
+2. Create a branch for your changes.
+3. Run tests before submitting.
+4. Open a pull request describing your changes and motivation.
+
+Smaller, focused pull requests are preferred.
+

swaggerizer-0.1.1/README.md

@@ -0,0 +1,145 @@
+# Swaggerizer
+
+**A lightweight CLI tool to modularize, maintain, and publish OpenAPI docs.**
+
+Swaggerizer takes a practical approach to OpenAPI docs management, in the sweet spot between too monolithic or too granular. It breaks up OpenAPI spec files by functional groups and uses a simple make-based system to reassemble them.
+
+The Swaggerizer project structure makes it easy for a single writer to build and maintain OpenAPI docs, or for a team of writers to collaborate using a docs-as-code approach.
+
+Swaggerizing your OpenAPI docs is _risk free_. It creates a separate source folder with the modularized project files, so you can test it out before committing to anything. Give it a try!
+
+## Features
+
+- Create a modular OpenAPI project from a single OpenAPI YAML file:
+   - Modularize an existing OpenAPI file, or start a new project from the default Petstore file
+   - Use make to test and reassemble a single OpenAPI file out of the project/source files 
+   - Project files are set up in the **openapi_src** sub-directory, with the following structure:
+      ```
+      openapi_src/
+      ├── 0_intro/        # Basic info, metadata, and tags
+      ├── 1_endpoints/    # Endpoint descriptions grouped by tag (one file per tag)
+      ├── 2_components/   # Reusable objects (schemas, parameters, examples, etc.)
+      ├── 3_misc/         # Additional top-level sections not categorized above
+      └── makefile        # Custom makefile to generate the final OpenAPI file
+      ```
+- Other features:
+   - Convert OpenAPI files from JSON → YAML or YAML → JSON 
+   - Validate YAML/JSON file formats
+   - Export an OpenAPI YAML file as HTML for publishing
+
+## Prerequisites
+
+- Python 3.8 or later
+- make
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install swaggerizer
+```
+
+Verify the installation:
+
+```bash
+swgrzr --help
+```
+
+## Quick start
+
+Create a new swaggerizer project from your existing **openapi.yaml** file:
+
+```bash
+swgrzr create -i openapi.yaml
+```
+
+Create a new swaggerizer project from the default Petstore file:
+
+```bash
+swgrzr create 
+```
+
+Build a testing version of the complete OpenAPI file from source:
+
+```bash
+cd openapi_src
+make
+```
+
+Copy the current testing version of the OpenAPI file into the parent directory for publishing:
+
+```bash
+make final-build
+```
+
+Export the OpenAPI YAML file as HTML:
+
+```bash
+swgrzr export -i openapi.yaml
+```
+
+## CLI usage
+
+### Syntax
+
+```
+swgrzr OPERATION [options]
+```
+
+### Available operations
+
+| Operation   | Description |
+|-------------|-------------|
+| create      | Create a new modularized project from an OpenAPI YAML file. |
+| export      | Export the input OpenAPI YAML as a rendered HTML document. |
+| json2yaml   | Convert an OpenAPI JSON file to YAML. |
+| yaml2json   | Convert an OpenAPI YAML file to JSON. |
+| validate    | Validate basic JSON or YAML structure. |
+
+### Common options
+
+| Option            | Description |
+|------------------|-------------|
+| -i, --input      | Input file path. Defaults vary by operation. |
+| -o, --output     | Output file path. Defaults vary by operation. |
+| -t, --type       | Input type for validation (`json`, `yaml`). |
+
+## How it works
+
+To create a modularized OpenAPI docs project, swaggerizer:
+
+1. Loads the source OpenAPI YAML.
+2. Detects the OpenAPI version (`v2` or `v3`).
+3. Extracts and groups the OpenAPI sections.
+4. Generates the modular project source directory.
+5. Adds the makefile to rebuild the spec.
+
+## Source code overview
+
+```
+swaggerizer/          # Metadata and packaging
+├── swaggerizer/      # Python app source 
+│   ├── cli.py        # CLI entry point
+│   ├── files/        # Default assets
+│   └── helpers/      # Helper modules
+```
+
+## How to help
+
+Feedback is appreciated! 
+
+Please:
+
+- Report bugs or unexpected behavior.
+- Propose enhancements to CLI commands or options.
+
+To contribute:
+
+1. Fork the swaggerizer repo.
+2. Create a branch for your changes.
+3. Run tests before submitting.
+4. Open a pull request describing your changes and motivation.
+
+Smaller, focused pull requests are preferred.
+

swaggerizer-0.1.1/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "swaggerizer"
+version = "0.1.1"
+description = "CLI tool to modularize and maintain OpenAPI docs"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "Apache-2.0" }
+authors = [{ name = "JR Halterlein", email = "jrhalterlein@gmail.com" }]
+dependencies = ["ruamel.yaml>=0.18,<0.19", "PyYAML>=6.0"]
+keywords = ["openapi", "swagger", "swaggerizer", "cli", "docs", "modularize"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Topic :: Software Development :: Documentation"
+]
+
+[project.scripts]
+swgrzr = "swaggerizer.cli:main"
+
+[project.urls]
+Homepage = "https://www.swaggerizer.com"
+Documentation = "https://docs.swaggerizer.com"
+Source = "https://github.com/jrhalterlein/swaggerizer"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["swaggerizer*"]
+
+[tool.setuptools.package-data]
+"swaggerizer" = ["files/*", "files/**"]
+

swaggerizer-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

swaggerizer-0.1.1/swaggerizer/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+__version__ = "0.1.0"
+

swaggerizer-0.1.1/swaggerizer/cli.py

@@ -0,0 +1,121 @@
+import argparse, os, shutil
+from .helpers.create_project import Swaggerizer
+from .helpers.html_exporter import HTMLExporter
+from .helpers.json2yaml_converter import json2YamlConverter
+from .helpers.yaml2json_converter import yaml2JsonConverter
+from .helpers.validator import validator
+
+
+def checkCreateOutputDir(output_arg):
+    # Create output directory if needed
+    output_dir = os.path.dirname(output_arg)
+    if output_dir and not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Swaggerize your API documentation.",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument(
+        "operation",
+        metavar="OPERATION",
+        choices=["create", "export", "json2yaml", "yaml2json", "validate"],
+        help=("Available operations:\n"
+              "    create = Create new modularized OpenAPI docs project\n"
+              "    export = Export OpenAPI YAML file as HTML\n"
+              "    json2yaml = Convert OpenAPI JSON file to YAML\n"
+              "    yaml2json = Convert OpenAPI YAML file to JSON\n"
+              "    validate = Validate basic JSON or YAML format"
+             )
+    )
+    parser.add_argument(
+        "-i", "--input",
+        metavar="IN_FILE",
+        default=None, 
+        help=("Input file or path. Default value per operation:\n"
+              "    create = './openapi.yaml'\n"
+              "    export = './openapi.yaml'\n"
+              "    json2yaml = './openapi.json'\n"
+              "    yaml2json = './openapi.yaml'"
+             )
+    )
+    parser.add_argument(
+        "-o", "--output",
+        metavar="OUT_FILE",
+        default=None,
+        help=("Output file or path. Default value per operation:\n"
+              "    export = '{IN_FILE}.html'\n"
+              "    json2yaml = '{IN_FILE}.yaml'\n"
+              "    yaml2json = '{IN_FILE}.json'"
+             )
+
+    )
+    parser.add_argument(
+        "-t", "--type",
+        metavar="FILE_TYPE",
+        default=None,
+        choices=["json", "yaml"], 
+        help=("File type for validate operation. Omit to get type\n"
+              "from file extension. Possible values:\n"
+              "    json = Validate basic JSON format.\n"
+              "    yaml = Validate basic YAML format."
+              )
+    )
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    # Handle the requested operation
+    if args.operation == "create":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Swaggerize it
+        project = Swaggerizer(args.input)
+        project.create()
+
+    elif args.operation == "export":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Export the HTML
+        exporter = HTMLExporter(args.input, args.output)
+        exporter.export()
+
+    elif args.operation == "json2yaml":
+        # Define default input 
+        args.input = args.input or "openapi.json"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Convert the JSON to YAML
+        converter = json2YamlConverter(args.input, args.output)
+        converter.convert()
+
+    elif args.operation == "yaml2json":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Convert the YAML to JSON
+        converter = yaml2JsonConverter(args.input, args.output)
+        converter.convert()
+
+    elif args.operation == "validate":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Validate the file
+        validator.validate(args.input, args.type)
+