fix: set JSONRenderer as the DEFAULT_RENDERER_CLASSES

[CodeWithEmad]

This will introduce a similar approach as edx-platform to set JSONRenderer as the DEFAULT_RENDERER_CLASSES. with this, we don't have Browsable APIs anymore. also, some code reformatting with black and RST cleanup in README.

See here for more context: https://github.com/overhangio/tutor-notes/pull/35

[openedx-webhooks]

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[kdmccormick]

Thanks for the PR @CodeWithEmad . I think the JSON change looks good. Let me see if there is a maintainer that'd want to review this before I merge it.

Regarding black, there is a cost associated with reformatting, in that it complicates git blame and makes it harder for folks with forks to rebase. So, my rule of thumb is that we should only reformat it if we also enforce the new style in CI so that we never need to apply the same reformatting again. Please remove the black commit from this PR, but feel free to introduce it in a new PR along with a black CI check if that interests you.

(the docs reformatting is good to stay -- the considerations about git and forks do not apply so much :)

[CodeWithEmad]

Sure @kdmccormick. Thanks for the explanation. I always make sure to leave any code base cleaner than how I found it. :)

[e0d]

@CodeWithEmad I've run the test. I've also added you to the triage team as you are covered under an entity CLA. This means that tests should run automatically for you in the future. Let me know if that doesn't happen.

[CodeWithEmad]

Thanks @e0d

[CodeWithEmad]

Let me know if that doesn't happen.

I pushed new changes but: "This workflow requires approval from a maintainer." @e0d

[mphilbrick211]

@CodeWithEmad the tests have been re-run - looks like some checks are still failing.

[CodeWithEmad]

That's super odd. I've added 1 DRF config and the tests are failing on installing the dependencies! I'll look into it.

[CodeWithEmad]

@mphilbrick211 All checks have passed.

[openedx-webhooks]

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[kdmccormick]

Thanks @CodeWithEmad !