https://github.com/ryuslash/avandu-lua
Lua (awesome) interface for Tiny Tiny RSS
https://github.com/ryuslash/avandu-lua
Last synced: 10 months ago
JSON representation
Lua (awesome) interface for Tiny Tiny RSS
- Host: GitHub
- URL: https://github.com/ryuslash/avandu-lua
- Owner: ryuslash
- License: gpl-3.0
- Created: 2014-06-18T00:19:23.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-20T14:49:24.000Z (about 12 years ago)
- Last Synced: 2025-04-22T17:17:07.852Z (over 1 year ago)
- Language: Lua
- Size: 293 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Avandu Lua
A Lua-based Tiny Tiny RSS API implementation, mostly meant for use in
the [awesome window manager](http://awesome.naquadah.org).
[](https://travis-ci.org/ryuslash/avandu-lua)
## Installation
Installation should go as follows.
### Grab it from github
There are currently no real releases, so using this module you will
need to get it from the git master branch.
git clone git://github.com/ryuslash/avandu-lua.git
### (If necessary) add it to `package.path`
Put it somewhere you can find it, perhaps in the general vicinity of
your awesome configuration.
Add the path to avandu-lua to `package.path`, if necessary:
package.path = '/path/to/avandu-lua/?.lua;' .. package.path
## Usage
Have a look at the examples to find out how to use Avandu Lua. Here is
a somewhat more general explanation.
### User credentials
In order to be able to log-in to Tiny Tiny RSS without asking the user
for the credentials each time the program is run, this information is
stored in `$HOME/.avandu.json`. This file should contain a single JSON
object containing a `user` and a `password` field, such as:
{'user': 'USERNAME', 'password': 'PASSWORD'}
Please make sure that this file is readable and writable only by you.
### Load it
As is usually the case with libraries, before you can use them you
must load them, this holds true for Avandu as well.
local avandu = require 'avandu'
### Set the Tiny Tiny RSS URL
The default value of `avandu.ttrss_url` is `nil`, which won't help you
if you're trying to connect, so before you can actually call any of
the functions you should tell Avandu where your Tiny Tiny RSS's API
can be accessed.
avandu.ttrss_url = 'https://example.com/tt-rss/api/'
### Logging
Avandu Lua occasionally logs some information. By default a dummy
logger is used which doesn't output anything, this is to keep the log
messages from clogging up whatever you use it with. To actually see
the logging you can specify your own logger.
local consolelog = require 'logging.console'
avandu.set_logger(consolelog())
## License
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .