Metadata-Version: 1.2
Name: ttrss
Version: 1.0.0
Summary: A tool for accessing a ttrss instance.
Home-page: https://pypi.python.org/pypi/ttrss
Author: eikendev
Author-email: raphael@eiken.dev
License: MIT
Description: Usage
        =====
        
        This tool can be used to interact with a `Tiny Tiny RSS <https://tt-rss.org/>`_ server through the command line.
        The main purpose of `ttrss` is to download the unread articles to the local machine.
        If you're a bit like me and prefer reading your feeds through the browser, you'll sure have been in the situation of not being able to access your feeds due to the lack of an internet connection.
        `ttrss` will help you to read articles offline in a very simple manner.
        
        For a quick introduction, let me show how you would use the tool to get started.
        ::
        
            $ ttrss synchronize -d ~/news/ --url https://ttrss.example.com/ --username example --keyring-service ttrss.example.com
        
        As can be seen above, you have to specify a directory where all unread articles will be saved in.
        Additionally, server information and login credentials must be provided.
        For now, be accessible through the `keyring` command line tool.
        
        Configuration
        =============
        
        A configuration file can be saved to `~/.config/ttrss/config.ini` to avoid specifying the path and other information for each invocation.
        Of course, `$XDG_CONFIG_HOME` can be set to change your configuration path.
        ::
        
            [GENERAL]
            RootDir = ~/news/
            Url = https://ttrss.example.com/
            Username = example
            KeyringService = ttrss.example.com
        
Keywords: ttrss,feed,rss,atom,cli
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Requires-Python: >=3
