mirror of
https://github.com/TrentSPalmer/hugo_themes_report.git
synced 2025-04-16 11:12:47 -07:00
update README because of python rewrite
This commit is contained in:
parent
8a6c39d6b8
commit
1f8cfdb021
57
README.md
57
README.md
@ -1,52 +1,15 @@
|
|||||||
# hugo_themes_report
|
# hugo_themes_report
|
||||||
By running this script you get a report with:
|
|
||||||
* Stars for each Theme
|
|
||||||
* Name of the Theme
|
|
||||||
* Name of the Repo owner
|
|
||||||
* Date of the latest commit
|
|
||||||
|
|
||||||
A Bash Script to Generate a Report and Rank Hugo Themes
|
Completely rewritten in python, using sqlite for persistent data, and using conditional github api requests to collect the data.
|
||||||
|
|
||||||
The website for the themes for the Hugo Static Site
|
Finally, the script builds two (somewhat) mobile responsive reports, using a bootstrap css table.
|
||||||
generator, don't tell you how popular, or how recently-updated
|
You get a report that ranks hugo themes by number of stars, and report that ranks hugo themes
|
||||||
the themes are. But this bash script will parse the github
|
by the commit date of each theme when they are referenced as submodules in the master repo of
|
||||||
api, and generate a little report for you with the
|
hugo themes.
|
||||||
number of stars, theme name, and date of most recent
|
|
||||||
commit.
|
|
||||||
|
|
||||||
But you'll need to set up a cron job, because you'll
|
I have the script running on a cron job, if you would like to see the result.
|
||||||
run into the github api limit if you try to look up
|
|
||||||
info on all 172 themes at once.
|
|
||||||
|
|
||||||
## Here's how you would set up a cron on Ubuntu 16.04
|
* [ranked by stars](http://107.161.27.86/hugo-themes-report/hugo-themes-by-num-stars.html)
|
||||||
You'll need to figure out what is your PATH.
|
* [ranked by commit date](http://107.161.27.86/hugo-themes-report/hugo-themes-by-last-commit-date.html)
|
||||||
```bash
|
* [master list of hugo themes](https://github.com/gohugoio/hugoThemes)
|
||||||
echo $PATH
|
* [hugo themes home page](https://themes.gohugo.io/)
|
||||||
```
|
|
||||||
And then you'll want to export your EDITOR, because
|
|
||||||
the `crontab -e` command invokes whatever editor
|
|
||||||
you have specified in your environment. i.e. for
|
|
||||||
vim `export EDITOR=vim` or add `export EDITOR=vim`
|
|
||||||
to `.bashrc`, (and then . your bashrc again or
|
|
||||||
restart bash).
|
|
||||||
|
|
||||||
The command to edit cron is `crontab -e`, and here's
|
|
||||||
what a cron that runs once an hour, at ten minutes
|
|
||||||
after the hour looks like. The new cron won't exist until
|
|
||||||
you save AND close the editor, just saving the file isn't enough.
|
|
||||||
|
|
||||||
```conf
|
|
||||||
#!/bin/bash
|
|
||||||
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
|
||||||
10 * * * * /home/<your user name>/bin/rank_hugo_themes.bash
|
|
||||||
```
|
|
||||||
|
|
||||||
Makes sure you make the script executable.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
chmod 755 ~/bin/rank_hugo_themes.bash
|
|
||||||
```
|
|
||||||
|
|
||||||
The raw output, represents what the report looks like in your terminal.
|
|
||||||
|
|
||||||
https://raw.githubusercontent.com/TrentSPalmer/hugo_themes_report/d83715fc3f6932b1e119a6ebfdb6a0000ac17049/example_output
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user