Metadata-Version: 1.2
Name: ttrss
Version: 1.1.5
Summary: A tool for synchronizing feeds from a Tiny Tiny RSS server.
Home-page: https://pypi.python.org/pypi/ttrss
Author: eikendev
Author-email: raphael@eiken.dev
License: MIT
Description: .. image:: https://img.shields.io/travis/eikendev/ttrss/master
           :alt: Build status
           :target: https://travis-ci.org/github/eikendev/ttrss/builds/
        
        .. image:: https://img.shields.io/pypi/status/ttrss
           :alt: Development status
           :target: https://pypi.org/project/ttrss/
        
        .. image:: https://img.shields.io/pypi/l/ttrss
           :alt: License
           :target: https://pypi.org/project/ttrss/
        
        .. image:: https://img.shields.io/pypi/pyversions/ttrss
           :alt: Python version
           :target: https://pypi.org/project/ttrss/
        
        .. image:: https://img.shields.io/pypi/v/ttrss
           :alt: Version
           :target: https://pypi.org/project/ttrss/
        
        .. image:: https://img.shields.io/pypi/dm/ttrss
           :alt: Downloads
           :target: https://pypi.org/project/ttrss/
        
        Usage
        =====
        
        This tool can be used to synchronize feeds from a `Tiny Tiny RSS <https://tt-rss.org/>`_ server.
        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, the only way of specifying a password is by using the ``keyring`` command line tool, which is passed the ``--username`` and the ``--keyring-service``.
        
        Installation
        ============
        
        From PyPI
        ---------
        ::
        
           pip install ttrss
        
        From Source
        -----------
        ::
        
           ./setup.py install
        
        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.
        Alternatively, the path to the configuration file can be set via the ``--config-file`` argument.
        ::
        
            [GENERAL]
            RootDir = ~/news/
            Url = https://ttrss.example.com/
            Username = example
            KeyringService = ttrss.example.com
        
        Development
        ===========
        
        The source code is located on `GitHub <https://github.com/eikendev/ttrss>`_.
        To check out the repository, the following command can be used.
        ::
        
           git clone https://github.com/eikendev/ttrss.git
        
Keywords: ttrss,feed,rss,atom,synchronize
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
