search

mitodl / open-edx-plugins

A repository of plugins for extending and customizing the behavior of Open edX projects
BSD 3-Clause "New" or "Revised" License
3 stars 3 forks source link

Project description on PyPI is empty for all the plugins in this repo #211

Open arslanashraf7 opened 1 year ago

arslanashraf7 commented 1 year ago

While looking at the package history of edx-sysadmin on PyPI. I noticed that the description has gone missing for the latest package generated from the plugins repo. The older versions (i.e. edx-sysadmin v0.2.2) published through its independent repo has the description whereas the latest version doesn't.

Expected Behavior

All the packages generated through open-edx-plugins should have the package description on PyPI.

Current Behavior

Empty description on PyPI for all the packages generated through open-edx-plugins.

Steps to Reproduce

Just check any of our ol-openedx-* plugins/packages

Possible Solution

pdpinch commented 1 year ago

This seems important to me, but I don't know what effort is involved. Do we have existing README.rst files for each plugin now? Is it suitable for populating PyPI project descriptions? In my head, I think READMEs might be too long for a project description.

arslanashraf7 commented 1 year ago

This seems important to me, but I don't know what effort is involved.

This should not be very difficult thing, We need to tweak the BUILD (i.e. edx_sysadmin/BUILD) files in each repo to export the README.rst files along with the package bundle.

Do we have existing README.rst files for each plugin now?

Yes, Each plugin has its independent README file inside the repo i.e. edx_sysadmin/README.rst

Is it suitable for populating PyPI project descriptions?

That's debatable. I would say It's almost suitable or at least better than having no description. Almost all of these packages follow a unified format in the README that consists of the following sections e.g. ol_openedx_checkout_external/README.rst:

  1. Description
  2. Installation
  3. Configuration
  4. How to Use
  5. Sample Usage

In my head, I think READMEs might be too long for a project description.

I agree, But we should be able to decided based on above mentioned details.