Get an overview of all projects you're maintainer of and keep an eye on
theirs statistics.
Information is automatically fetched via Github API (public).
Use case: if you maintain lots of projects on Github and want to keep an eye
on those.
So this module's probably only useful for a handful of people. It provides
no value for BackdropCMS users or admins.
Add projects via form on github-project/add, you have to add the project
name and the Github path. The rest gets fetched automatically.
There's an overview table on github-project/list.
Permissions aren't very fine grained. Adapt as needed on
admin/config/people/permissions#module-github_stats.
A cron job will keep infos up to date, make sure cron runs regularly.
Optional settings
There's no admin UI for settings, but some options are available via
settings.php (or settings.local.php):
$settings['github_stats_expire_after'] = 86400;
$settings['github_stats_max_per_cron'] = 5;
$settings['github_stats_api_token'] = '';
- github_stats_expire_after: the number of seconds after which fresh
information should get fetched via cron. Defaults to one day. - github_stats_max_per_cron: The maximum number of items to fetch per cron run.
Defaults to 5. - github_stats_api_token: The Github API token to use for fetching (to get
a much higher rate limit). If no token is set, the public API will be used.
The personal access token doesn't need any special access privileges, as
every info this module fetches is public content, anyway.
Learn how to
create a Github access token.
Note: you don't need a token at all, if you don't fetch too many projects
(or too often). Too much means: more than 30 projects per hour.
Installation
- Install this module using the official Backdrop CMS instructions
Issues
Bugs and feature requests should be reported in the Issue Queue
Known issues
The usage count fetched from backdropcms.org has a long delay. The number
seems to get updated there once a week, but because of caching, the delay's
probably rather two weeks or more.
Current Maintainers
- Indigoxela
- Additional maintainers welcome
License
This project is GPL v3 software. See the LICENSE.txt file in this directory for complete text.