dpocock / github-icalendar Goto Github PK

Some objects should be cached to reduce the number of hits on the Github API

e.g. if we start looking up user records in order to put the issue reporter email address in the VTODO then we should cache them because people change their email addresses very rarely

The Beaker project may be useful, it is already packaged:

https://beaker.readthedocs.org/

If people are making their iCalendar feed available without authentication, they may not want to expose issues from their private repositories.

Provide a config option to exclude private repositories.

Github provides a way to preview new versions of their API

This could be enabled with a setting in the configuration file

It depends on the api_preview parameter in PyGithub:

PyGithub/PyGithub#294

The issues don't contain the reporter email addresses, just the Github login IDs. These are being used to construct the contact ID in the VTODO but this is not ideal.

It is possible to get the proper email addresses by doing a second API query for each issue. These should be cached, see issue #1

I am getting an error "ModuleNotFoundError: No module named 'github' " on executing the command "./github_icalendar/main.py github-ics.cfg".

iCalendar supports category strings.

We could just use a constant such as 'Github' as the category for all issues

We could also use each repository name as a category name

Github provides a label mechanism:

https://help.github.com/articles/creating-and-editing-labels-for-issues-and-pull-requests/

These could be used in various ways:

• to filter the list of issues that should appear in a feed
• to prioritize the issues in the feed (setting a higher iCalendar priority on some items)
• to set the iCalendar categories for some issues
• to set a due date for some issues