Metadata-Version: 2.1
Name: fred-fileman
Version: 0.1.0
Summary: Fred-fileman is a service for file management.
Home-page: UNKNOWN
Author: Vlastimil Zíma
Author-email: vlastimil.zima@nic.cz
License: GPLv3+
Description: ============
        Fred-fileman
        ============
        
        Fred-fileman is a service for file management.
        
        Learn more about the project and our community on the `FRED's home page`__
        
        .. _FRED: https://fred.nic.cz
        
        __ FRED_
        
        
        Configuration
        =============
        
        Fileman searches for configuration files in following order:
        
        1. Configuration file set by ``FILEMAN_CONFIG`` environment variable.
        2. Configuration file set by ``--config`` option of a command.
        3. ``~/.fred/fileman.conf``
        4. ``/etc/fred/fileman.conf``
        
        The configuration file is in YAML format with following options:
        
        ``db_connection``
        -----------------
        A connection string to database.
        See https://docs.sqlalchemy.org/en/13/core/engines.html#database-urls for possible values.
        Default is ``sqlite:///:memory:``.
        
        ``db_echo``
        -----------
        Whether to log SQL statements.
        Default is ``False``.
        
        ``db_poolclass``
        ----------------
        Dotted path to a pool class.
        See https://docs.sqlalchemy.org/en/13/core/pooling.html for details.
        Default is ``None``, i.e. use SQLAlchemy default pool class.
        
        ``grpc_port``
        -------------
        Port to which the fileman gRPC service will bind and listen.
        Default is 50051.
        
        ``logging``
        -----------
        Logging configuration, see https://docs.python.org/3.8/library/logging.config.html for possible values.
        Default is ``None``, i.e. use ``logging`` defaults.
        
        ``max_workers``
        ---------------
        Maximum number of workers for gRPC server, see https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ThreadPoolExecutor.
        Default is ``None``, i.e. use Python library default.
        Implemented to avoid problems with too many workers on many-core machines under Python < 3.8.
        
        ``sentry_dsn``
        --------------
        Sentry data source name (DSN), see https://docs.sentry.io/product/sentry-basics/dsn-explainer/.
        If provided, Sentry client is set up.
        Default is ``None``, i.e. Sentry is not used.
        
        ``storage_root``
        ----------------
        Path to the root of the file system storage.
        Default is ``/var/lib/fileman``.
        
        ChangeLog
        =========
        
        .. contents:: Releases
           :backlinks: none
           :local:
        
        0.1.0 (2020-06-16)
        ------------------
        
        Initial version.
        
        * Add read-only access to files.
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Office/Business
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: ~=3.5
Provides-Extra: test
Provides-Extra: quality
Provides-Extra: sentry
