{"id":27601287,"url":"https://github.com/ryuslash/avandu-lua","last_synced_at":"2025-10-07T06:50:16.097Z","repository":{"id":17956779,"uuid":"20943760","full_name":"ryuslash/avandu-lua","owner":"ryuslash","description":"Lua (awesome) interface for Tiny Tiny RSS","archived":false,"fork":false,"pushed_at":"2014-07-20T14:49:24.000Z","size":300,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-22T17:17:07.852Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryuslash.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-18T00:19:23.000Z","updated_at":"2016-12-08T05:28:21.000Z","dependencies_parsed_at":"2022-09-24T20:12:50.861Z","dependency_job_id":null,"html_url":"https://github.com/ryuslash/avandu-lua","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ryuslash/avandu-lua","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryuslash%2Favandu-lua","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryuslash%2Favandu-lua/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryuslash%2Favandu-lua/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryuslash%2Favandu-lua/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryuslash","download_url":"https://codeload.github.com/ryuslash/avandu-lua/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryuslash%2Favandu-lua/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278734407,"owners_count":26036404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-22T17:17:06.817Z","updated_at":"2025-10-07T06:50:16.077Z","avatar_url":"https://github.com/ryuslash.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Avandu Lua\n\nA Lua-based Tiny Tiny RSS API implementation, mostly meant for use in\nthe [awesome window manager](http://awesome.naquadah.org).\n\n[![Build Status](https://travis-ci.org/ryuslash/avandu-lua.svg?branch=master)](https://travis-ci.org/ryuslash/avandu-lua)\n\n## Installation\n\nInstallation should go as follows.\n\n### Grab it from github\n\nThere are currently no real releases, so using this module you will\nneed to get it from the git master branch.\n\n        git clone git://github.com/ryuslash/avandu-lua.git\n\n### (If necessary) add it to `package.path`\n\nPut it somewhere you can find it, perhaps in the general vicinity of\nyour awesome configuration.\n\nAdd the path to avandu-lua to `package.path`, if necessary:\n\n        package.path = '/path/to/avandu-lua/?.lua;' .. package.path\n\n## Usage\n\nHave a look at the examples to find out how to use Avandu Lua. Here is\na somewhat more general explanation.\n\n### User credentials\n\nIn order to be able to log-in to Tiny Tiny RSS without asking the user\nfor the credentials each time the program is run, this information is\nstored in `$HOME/.avandu.json`. This file should contain a single JSON\nobject containing a `user` and a `password` field, such as:\n\n    {'user': 'USERNAME', 'password': 'PASSWORD'}\n\nPlease make sure that this file is readable and writable only by you.\n\n### Load it\n\nAs is usually the case with libraries, before you can use them you\nmust load them, this holds true for Avandu as well.\n\n        local avandu = require 'avandu'\n\n### Set the Tiny Tiny RSS URL\n\nThe default value of `avandu.ttrss_url` is `nil`, which won't help you\nif you're trying to connect, so before you can actually call any of\nthe functions you should tell Avandu where your Tiny Tiny RSS's API\ncan be accessed.\n\n        avandu.ttrss_url = 'https://example.com/tt-rss/api/'\n\n### Logging\n\nAvandu Lua occasionally logs some information. By default a dummy\nlogger is used which doesn't output anything, this is to keep the log\nmessages from clogging up whatever you use it with. To actually see\nthe logging you can specify your own logger.\n\n    local consolelog = require 'logging.console'\n    avandu.set_logger(consolelog())\n\n## License\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryuslash%2Favandu-lua","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryuslash%2Favandu-lua","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryuslash%2Favandu-lua/lists"}