Skip to content
Content fetch and aggregation bot for hugo data-driven websites
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bitcoin
config
db
encoder
export
feeds
filters
github
handlers
logging
posts
static
types
utils
.gitignore
Dockerfile
Dockerfile-sqliteweb
LICENSE
Makefile
README.md
api.go
commands.go
config.toml
docker-compose.yml
docker-entrypoint.sh
feed_commands.go
go.mod
go.sum
jobs.go
main.go
parse_test.go
posts_test.go
scheduler.go
server.go

README.md

MIRRORED FROM: https://git.sp4ke.com/sp4ke/hugobot

HUGOBOT

hugobot is a an automated content fetch and aggregation bot for Hugo data driven websites. It has the following features:

Data fetch

  • Use the feeds table to register feeds that will periodically fetched stored and exported into the hugo project.
  • Currently handles these types of feeds: RSS, Github Releases, Newsletters
  • Define your own feed types by implementing the JobHandler interface (see handlers/handlers.go).
  • Hugobot automatically fetch new posts from the feeds you defined
  • It runs periodically to download new posts in the defined feeds.
  • Storage is done with sqlite.
  • The scheduler can handle any number of tasks and uses leveldb for caching/resuming jobs.

Hugo export

  • Data is automatically exported to the configured Hugo website path.
  • It can export markdwon files or json/toml data files
  • All fields in the exported files can be customized
  • You can define custom output formats by using the FormatHandler interface.
  • You can register custom filters and post processing on exports to avoid changing the raw data stored in the db.
  • You can force export of content through the CLI

API

  • Uses gin-gonic.

  • hugobot also includes a webserver API that can be used with Hugo Data Driven Mode.

  • Insert and query data from the db. This is still a WIP, you can easily add the missing code on the API side to automate adding/querying data from the DB.

  • An example usage is the automated generation of Bitcoin addresses for new articles on bitcointechweekly.com

Other

  • Some commands are available through the CLI, you can add your own custom commands.

Sqliteweb interface

  • See Docker files

First time usage

  • The database is automatically generated the first time you run the program. You can add your feeds straight into the sqlite db using your favorite sqlite GUI or the provided web gui in the docker-compose file.
You can’t perform that action at this time.