Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Provide an enhanced JSON renderer #23

Open
zupo opened this issue May 22, 2019 · 16 comments
Open

Provide an enhanced JSON renderer #23

zupo opened this issue May 22, 2019 · 16 comments
Labels
good first issue Good for newcomers

Comments

@zupo
Copy link
Collaborator

zupo commented May 22, 2019

I like the pyramid_swagger renderer from pyramid_swagger library.

With it, I can remove custom renderers from the realworld example app. And less code is always nice.

We can probably reuse the idea, or possibly even some code.

@zupo zupo added the good first issue Good for newcomers label May 22, 2019
@Vardhan-Kaashikar
Copy link

Hey @zupo I am new open source contributing, can I give this one a try?

@zupo
Copy link
Collaborator Author

zupo commented Feb 17, 2021

@Vk24-hash: sure thing! Let me know if you need help.

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 18, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 18, 2021

The idea is to ship pyramid_openapi3 with a custom JSON renderer, so that applications using pyramid_openapi3 (for example, the real-world-example-app) do not need to come up with their own custom JSON renderer -- they just use what pyramid_openapi3 provides.

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 18, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 18, 2021

I suppose, yes. I cannot know until I see it in action.

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 21, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 22, 2021

Where are the changes?

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 22, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 22, 2021

Ah yes, now I remember. The changes should be done here in this repo.

And yes, tests need to pass before the PR can be merged :)

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 22, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 22, 2021

I haven't thought this through so this is coming from the top of my head: it seems it makes sense to have a renderers.py file in https://github.com/Pylons/pyramid_openapi3/blob/master/pyramid_openapi3/.

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 25, 2021 via email

@zupo
Copy link
Collaborator Author

zupo commented Feb 25, 2021

Maybe a good approach is to familiarize yourself with Pyramid, this tutorial is good: https://docs.pylonsproject.org/projects/pyramid/en/latest/quick_tutorial/

@stevepiercy
Copy link
Member

The Quick Tutorial is good for learning concepts in Pyramid. For a realistic application, I would point you to the wiki tutorial, which implements the concepts learned in the Quick Tutorial using best practices.

@Vardhan-Kaashikar
Copy link

Vardhan-Kaashikar commented Feb 26, 2021 via email

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants