• Search by Module
• Search by Words
• Search Projects

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• flask-rebar-master
  • .github
    • workflows
      • tag.yml
      • pullrequests.yml
  • AUTHORS
  • examples
    • todo
      • generate_output.py
      • todo.py
      • todo_output.md
      • __init__.py
    • __init__.py
  • flask_rebar
    • utils
      • request_utils.py
      • deprecation.py
      • __init__.py
      • defaults.py
    • request_utils.py
    • messages.py
    • authenticators
      • header_api_key.py
      • __init__.py
      • base.py
    • rebar.py
    • validation.py
    • __init__.py
    • errors.py
    • compat.py
    • swagger_generation
      • authenticator_to_swagger.py
      • generator_utils.py
      • swagger_words.py
      • swagger_objects.py
      • swagger_generator
        • __init__.py
      • swagger_generator_base.py
      • __init__.py
      • swagger_generator_v3.py
      • marshmallow_to_swagger.py
      • swagger_generator_v2.py
    • swagger_ui
      • templates
        • index.html.jinja2
      • blueprint.py
      • __init__.py
      • static
        • swagger-ui.css
        • oauth2-redirect.html
        • swagger-ui.css.map
    • testing
      • swagger_jsonschema.py
      • __init__.py
  • .pre-commit-config.yaml
  • LICENSE
  • .readthedocs.yml
  • CODEOFCONDUCT.md
  • README.rst
  • .bumpversion.cfg
  • setup.py
  • CHANGELOG.rst
  • setup.cfg
  • .gitchangelog.rc
  • CONTRIBUTING.rst
  • tests
    • test_errors.py
    • test_deprecation_utils.py
    • examples
      • test_todo.py
      • __init__.py
    • test_request_utils.py
    • __init__.py
    • test_rebar.py
    • test_validation.py
    • swagger_generation
      • test_marshmallow_to_swagger.py
      • test_swagger_generator.py
      • test_generator_utils.py
      • __init__.py
      • registries
        • exploded_query_string.py
        • legacy.py
        • __init__.py
        • multiple_authenticators.py
    • helpers.py
  • pyproject.toml
  • CODEOWNERS
  • .gitignore
  • docs
    • Makefile
    • make.bat
    • why.rst
    • meeting_notes
      • roadmap_2020Jan29.rst
    • quickstart
      • api_versioning.rst
      • authentication.rst
      • basics.rst
      • swagger_generation.rst
      • installation.rst
    • api_reference.rst
    • tutorials.rst
    • index.rst
    • conf.py
    • changelog.rst
    • recipes.rst
    • contributing.rst
  • MANIFEST.in

import os
import subprocess
import json
import contextlib


this_directory = os.path.dirname(os.path.realpath(__file__))
todo_app_filepath = os.path.join(this_directory, "todo.py")
todo_output_filepath = os.path.join(this_directory, "todo_output.md")


@contextlib.contextmanager
def app():
    print("Starting app...")

    app_process = None
    try:
        app_process = subprocess.Popen(
            args=["python", todo_app_filepath],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
        )

        # Wait for the app to startup by polling the service
        up = False
        while not up:
            try:
                subprocess.check_output(
                    "curl -s http://127.0.0.1:5000/swagger", shell=True
                )
                up = True
            except subprocess.SubprocessError:
                pass

        yield

    finally:
        if app_process:
            app_process.terminate()


def main():
    output = []

    with app():
        output.extend(
            [
                "# cURL and examples/todo.py",
                "Here's a snippet of playing with the application inside todo.py.",
                "",
            ]
        )

        for title, commands in [
            ("Swagger for free!", ["curl -s -XGET http://127.0.0.1:5000/swagger"]),
            (
                "Request validation!",
                [
                    'curl -s -XPATCH http://127.0.0.1:5000/todos/1 -H "X-MyApp-Key: my-api-key" -H "Content-Type: application/json" -d \'{"complete": "wrong type, for demonstration of validation"}\''
                ],
            ),
            (
                "Authentication!",
                [
                    "curl -s -XGET http://127.0.0.1:5000/todos",
                    'curl -s -XGET http://127.0.0.1:5000/todos -H "X-MyApp-Key: my-api-key"',
                ],
            ),
            (
                "CRUD!",
                [
                    'curl -s -XPOST http://127.0.0.1:5000/todos -H "X-MyApp-Key: my-api-key" -H "Content-Type: application/json" -d \'{"complete": false, "description": "Find product market fit"}\'',
                    'curl -s -XPATCH http://127.0.0.1:5000/todos/1 -H "X-MyApp-Key: my-api-key" -H "Content-Type: application/json" -d \'{"complete": true}\'',
                    'curl -s -XGET http://127.0.0.1:5000/todos -H "X-MyApp-Key: my-api-key"',
                ],
            ),
        ]:
            output.extend([title, "```"])

            for command in commands:
                print(command)

                result = subprocess.check_output(command, shell=True)

                output.extend(
                    ["$ " + command, json.dumps(json.loads(result), indent=2)]
                )

            output.extend(["```", ""])

    print("Writing output to {}".format(todo_output_filepath))

    with open(todo_output_filepath, "w") as f:
        f.write("\n".join(output))

    print("Done!")


if __name__ == "__main__":
    main()