search

jataware / domain-model-examiner

The goal of this process is to perform machine reading over the model codebase in order to automatically extract key metadata.
MIT License
1 stars 0 forks source link

Extract repo "About" as model description #4

Closed brandomr closed 3 years ago

brandomr commented 3 years ago

Some Github repo's have nice "About" sections. We should attempt to mine these and use them for some or all of the model description.

For example, for FSC the About reads:

Food Shocks Cascade Model: A simple agent-based network model that computes chain-reactions due to production anomalies based on dynamic food balance sheets at the country level.

GoogleSheets commented 3 years ago

Latest commit includes "About" section, herein defined as the first section bounded by # in the READ.ME. Is there some type of symbology used formally denote an "About" section?

brandomr commented 3 years ago

It looks like some repos have About sections that differ from the README. Check out FSC's:

Screen Shot 2021-05-04 at 10 04 10 AM
GoogleSheets commented 3 years ago

Got it. GitPython doesn't pick it up, but the GitHub API will: (https://api.github.com/repos/mjpuma/FSC-WorldModelers)

"description": "Food Shocks Cascade Model: A simple agent-based network model that computes chain-reactions due to production anomalies based on dynamic food balance sheets at the country level.",

brandomr commented 3 years ago

Nice!