Dagger
Search

miniflux

This module implements the miniflux python library.
https://miniflux.app/docs/api.html

Installation

dagger install github.com/levlaz/daggerverse/miniflux@v0.4.0

Entrypoint

Return Type 
Miniflux !
Arguments
NameTypeDescription
hostString !url for miniflux instance
tokenSecret !miniflux API token
categoryIdString optional, category id for blogroll, if not set will grab all feeds.
Example
func (m *myModule) example(host string, token *Secret) *Miniflux  {
	return dag.
			Miniflux(host, token)
}
@function
def example(host: str, token: dagger.Secret, ) -> dag.Miniflux:
	return (
		dag.miniflux(host, token)
	)
@func()
example(host: string, token: Secret, ): Miniflux {
	return dag
		.miniflux(host, token)
}

Types

Miniflux 🔗

generateSources() 🔗

Generate sources file for openring

This function grabs all the feeds from a given category in miniflux, grabs the feed_url and then generates a sources.txt file for the purpose of feeding it into the openring module.

https://daggerverse.dev/mod/github.com/levlaz/daggerverse/openring@39958eb474dcb1922439b2a829be6af71d6bc263#Openring.openring

Return Type 
File !
Example
dagger -m github.com/levlaz/daggerverse/miniflux@a3dc5b44e9b94554f074ee4fbd925bf1a1046616 call \
 --host string --token env:MYSECRET generate-sources
func (m *myModule) example(host string, token *Secret) *File  {
	return dag.
			Miniflux(host, token).
			GenerateSources()
}
@function
def example(host: str, token: dagger.Secret, ) -> dagger.File:
	return (
		dag.miniflux(host, token)
		.generate_sources()
	)
@func()
example(host: string, token: Secret, ): File {
	return dag
		.miniflux(host, token)
		.generateSources()
}

generateBlogroll() 🔗

Generate blogroll template

This function uses the Jinja templating library to create a blog roll list that you can embed in your own website based on the blogs you read in miniflux.

Return Type 
File !
Example
dagger -m github.com/levlaz/daggerverse/miniflux@a3dc5b44e9b94554f074ee4fbd925bf1a1046616 call \
 --host string --token env:MYSECRET generate-blogroll
func (m *myModule) example(host string, token *Secret) *File  {
	return dag.
			Miniflux(host, token).
			GenerateBlogroll()
}
@function
def example(host: str, token: dagger.Secret, ) -> dagger.File:
	return (
		dag.miniflux(host, token)
		.generate_blogroll()
	)
@func()
example(host: string, token: Secret, ): File {
	return dag
		.miniflux(host, token)
		.generateBlogroll()
}

generateStarred() 🔗

Generate list of starred posts

This function generates a file of links for your starred posts, by default you will get the 10 most recent.

Return Type 
File !
Arguments
NameTypeDefault ValueDescription
headingString !"Recent Favorite Blog Posts"section heading text
directionString !"desc"Order to retrieve posts, desc or asc
limitInteger !10number of posts to return
Example
dagger -m github.com/levlaz/daggerverse/miniflux@a3dc5b44e9b94554f074ee4fbd925bf1a1046616 call \
 --host string --token env:MYSECRET generate-starred --heading string --direction string --limit integer
func (m *myModule) example(host string, token *Secret, heading string, direction string, limit int) *File  {
	return dag.
			Miniflux(host, token).
			GenerateStarred(heading, direction, limit)
}
@function
def example(host: str, token: dagger.Secret, heading: str, direction: str, limit: int) -> dagger.File:
	return (
		dag.miniflux(host, token)
		.generate_starred(heading, direction, limit)
	)
@func()
example(host: string, token: Secret, heading: string, direction: string, limit: number): File {
	return dag
		.miniflux(host, token)
		.generateStarred(heading, direction, limit)
}