Toolhub/Progress reports/2020-10-30

Report on activities in the Toolhub project for the week ending 2020-10-30.

Initial backend API

Tracked in Phabricator:
Task T264808 resolved

Bryan worked on several patches to introduce the scaffolding for API endpoints in the Django backend. The Django REST Framework library is being used to do most of the heavy lifting here with help from add-on packages like drf-spectacular to assist in generating an OpenAPI schema and django-filter for result set filtering.

OpenAPI schema viewer

Bryan reviewed a number of tools for rendering an OpenAPI specification as documentation for users listed at openapi.tools. General utility and ease of integration with Toolhub were the main focus of his investigation. Ultimately he picked [<https://mrin9.github.io/RapiDoc/ RapiDoc] and integrated it with the Vue frontend.

Toolinfo.json URL registration

The backend API now has support for CRUD operations on toolinfo.json source urls that will be harvested by the crawler. Srishti is working on creating the Vue frontend that users will use to manage their URLs.

Wrap up

Progress, and learning about the new to us tools being used in the project, continues at a steady pace. As a greenfield project that is using many components new to the developers and largely new to the Foundation there has been some "two steps forward, one step back" activities as making progress on a given milestone uncovers weaknesses in or omissions of tertiary features. This sort of thing is to be expected and thus far has not become disruptive to the overall progress and timeline. We are in the last week of the first month of the quarter, but due to the number of holiday and vacation breaks in November and December we are closer to half way through the available working hours for the quarter. We will continue to evaluate progress versus the roadmap and try to keep everyone informed of potential changes in what we believe will be {{done}} by the end of the quarter.