Compiling list of Plugins with issues seeking help #285

joethei · 2022-02-03T17:20:43Z

Added

A script that retrieves all issues with the labels documentation, help wanted, and good first issue .
As discussed here: https://discord.com/channels/686053708261228577/915679988118863933/937297550044708934

To test this you can run the update_issues.py script
You need a github api key in the apikey parameter, the api key does not need any permissions, just needs to exists to not hit any rate limits.

The current implementation would hit the rate limit once there are around 1.666 plugins.

ToDo

Link to this in #273
add a GH action that runs every day, and creates a PR if necessary
Decide on a good location & name for the output file
Decide on any other labels that might be added
Write some introductory text
Do the same thing for themes?
Sort the output properly(currently sorted by plugin entry date to the list)

Checklist

before creating a new note, I searched the vault
new notes have the .md extension
(if applicable) attached images have descriptive file names
(if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

claremacrae · 2022-02-05T18:15:41Z

Thanks very much indeed for doing this!

I've been wanting to find out about the GitHub API for ages, so I decided to use running this script as a way to start learning about it.

I was able to get a GitHub Access token, and your note about no permissions being needed was helpful.

When I ran it, I got lots of output of the form:

cabundle "/etc/ssl/certs/ca-certificates.crt" is not accessible
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
-----
Processing plugin issues....

documentation-----------------------------------------------------------------------------------------| 0.0% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 0.2% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 0.4% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 0.6% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 0.9% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 1.1% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 1.3% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 1.5% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
documentation-----------------------------------------------------------------------------------------| 1.7% 
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
help wanted
.../obsidian-hub/venv/lib/python3.8/site-packages/urllib3/connectionpool.py:1013: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.github.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
good first issue

joethei · 2022-02-05T18:19:02Z

What system are you running this on?
I did run into this issue while running this code with PyCharm, but running the same code with Ubuntu in WSL did not produce this error?

claremacrae · 2022-02-05T18:21:44Z

What system are you running this on?
I did run into this issue while running this code with PyCharm, but running the same code with Ubuntu in WSL did not produce this error?

Thanks. I'm on Mac, and I am running it with a PyCharm terminal window...

I'll try it again, from outside of PyCharm, and see what happens.

claremacrae · 2022-02-05T18:23:24Z

Wow - here is an example of the current output file that is generated:

06 - Inbox/Plugin Issues.md

🎉

claremacrae · 2022-02-05T18:26:05Z

I'll try it again, from outside of PyCharm, and see what happens.

I did get the same result in an ordinary terminal window, but in fairness, it does contain a link to further info, so I will make time to read that:
https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings

claremacrae · 2022-02-05T18:36:00Z

Looking at the headings in the file it generates, I see that it currently finds issues with Documentation and Good first issue, but no Help Wanted, although it does search for that label...

Ah no, my mistake. I saw just the two level-2 headings, and didn't realise that the level-1 "Help wanted" heading is the heading for the "help wanted" list...

claremacrae · 2022-02-05T18:39:30Z

Wow there's a lot of issues with cryptic summaries!

joethei · 2022-02-05T18:39:52Z

Looking at the headings in the file it generates, I see that it currently finds issues with Documentation and Good first issue, but no Help Wanted, although it does search for that label...

Ah no, my mistake. I saw just the two level-2 headings, and didn't realise that the level-1 "Help wanted" heading is the heading for the "help wanted" list...

Thanks for pointing that out, this is not intended.

joethei · 2022-02-05T18:40:36Z

Wow there's a lot of issues with cryptic summaries!

I think we should add at least the plugin name, maybe even more, to the output

claremacrae · 2022-02-05T18:46:27Z

I think we should add at least the plugin name, maybe even more, to the output

I think that's a great idea.

I feel like you've solved 90% of the problem - and probably 90% of the discussion (on formatting and structure of the output) is still to come to come 🤣

claremacrae · 2022-02-05T18:48:17Z

I really liked that you put this at the top of the file:

%% do not edit this file %%

claremacrae · 2022-02-05T18:49:44Z

In the todo list at the top of the issue, I think it's probably worth including a note to decide on some descriptive text at the top of the file...

joethei · 2022-02-05T18:52:46Z

In the todo list at the top of the issue, I think it's probably worth including a note to decide on some descriptive text at the top of the file...

In case somebody stumbles onto the note on its own?
I already intend on linking the output in #273

claremacrae · 2022-02-05T19:23:57Z

In the todo list at the top of the issue, I think it's probably worth including a note to decide on some descriptive text at the top of the file...

In case somebody stumbles onto the note on its own?

Yes...

I already intend on linking the output in #273

That sounds good.

joethei · 2022-02-15T18:52:18Z

I have added some text and a GH action, the only thing left is deciding where the output file ends up,
I would put it next to the Volunter plugin docs file.

claremacrae

This review is by both me and @chrisgrieser ...

Huge thanks for this - the descriptive text is really improved!

Our recommendations:

The output file should be put in 01 - Community in a new sub-folder called Contributing to the Community.
Please could the output file be called Plugins seeking help.md

As a separate step, we can move the Volunteers page there too.

We're comfortable running the GitHub Action daily - if one doesn't get merged before the next run, the earlier one can always be closed...

.github/workflows/update_issues.yml

.github/scripts/templates/plugin_issues.md.jinja

joethei · 2022-02-16T17:45:01Z

Adressed those comments, and I think this pr is ready for review.

Once this is merged I would like a test run of the action.
I remember reading somewhere that the token that GH issues to actions might not have the required permissions for this to work(but I cannot find it).

claremacrae · 2022-02-16T18:26:36Z

@joethei Thanks for making those changes!

I see you merged in from main, and that has brought in the new requirement that python code has type-hints (and so the python build failed)

Do you have experience with python type hints already?

If not, as the person who set up the requirement, I don't mind adding them to the code on your branch...

joethei · 2022-02-16T18:28:39Z

Do you have experience with python type hints already?

Not with python, but from what I have seen so far this seems easy enough.

claremacrae · 2022-02-16T18:31:43Z

Do you have experience with python type hints already?

Not with python, but from what I have seen so far this seems easy enough.

Thanks... to test on your machine, you should be able to run check_type_hints.sh script - if you are on unix...

joethei · 2022-02-17T08:46:35Z

Types hints have been added.

claremacrae

Thank you, this is great!

joethei added 2 commits February 3, 2022 17:58

add github issue parsing

1eafdaa

Merge remote-tracking branch 'origin/main'

0ed020f

claremacrae changed the title ~~Compiling Plugin issues~~ Compiling list of Plugins with issues seeking help Feb 5, 2022

joethei added 2 commits February 15, 2022 11:12

add gh action to update issues daily

8b442b1

add some text to plugin issue note

35539d5

claremacrae requested changes Feb 16, 2022

View reviewed changes

joethei added 2 commits February 16, 2022 18:33

adress review comments

f312473

Merge branch 'main' into main

dc935f7

joethei marked this pull request as ready for review February 16, 2022 17:45

claremacrae mentioned this pull request Feb 16, 2022

Add dataview to volunteer plugin doc writers #294

Merged

adding typehints

aa369fe

claremacrae approved these changes Feb 18, 2022

View reviewed changes

claremacrae merged commit 8d514c8 into obsidian-community:main Feb 18, 2022

joethei mentioned this pull request Mar 4, 2022

Enable automatic issue collection #323

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compiling list of Plugins with issues seeking help #285

Compiling list of Plugins with issues seeking help #285

joethei commented Feb 3, 2022 •

edited

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022 •

edited

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 15, 2022

claremacrae left a comment

joethei commented Feb 16, 2022

claremacrae commented Feb 16, 2022 •

edited

joethei commented Feb 16, 2022

claremacrae commented Feb 16, 2022

joethei commented Feb 17, 2022

claremacrae left a comment

Compiling list of Plugins with issues seeking help #285

Compiling list of Plugins with issues seeking help #285

Conversation

joethei commented Feb 3, 2022 • edited

Added

ToDo

Checklist

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022 • edited

claremacrae commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 5, 2022

claremacrae commented Feb 5, 2022

joethei commented Feb 15, 2022

claremacrae left a comment

Choose a reason for hiding this comment

joethei commented Feb 16, 2022

claremacrae commented Feb 16, 2022 • edited

joethei commented Feb 16, 2022

claremacrae commented Feb 16, 2022

joethei commented Feb 17, 2022

claremacrae left a comment

Choose a reason for hiding this comment

joethei commented Feb 3, 2022 •

edited

claremacrae commented Feb 5, 2022 •

edited

claremacrae commented Feb 16, 2022 •

edited