Metadata-Version: 1.2
Name: coverage2sql
Version: 0.0.1.dev117
Summary: Command to Read a coverage file and put the data in a SQL database
Home-page: https://docs.openstack.org/coverage2sql/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: UNKNOWN
Description: ========================
        Team and repository tags
        ========================
        
        .. image:: https://governance.openstack.org/tc/badges/coverage2sql.svg
            :target: https://governance.openstack.org/tc/reference/tags/index.html
        
        .. Change things from this point on
        
        ===============================
        coverage2sql README
        ===============================
        
        Command to Read a coverage file and put the data in a SQL database
        
        coverage2sql is a tool for storing data of test coverage into a SQL database.
        With using this tool, you can store time series coverage data and analyze it
        if your coverage rate is down.
        
        * Free software: Apache license
        * Documentation: https://docs.openstack.org/coverage2sql/latest/
        * Source: https://opendev.org/openstack/coverage2sql
        * Bugs: https://bugs.launchpad.net/coverage2sql
        * Release notes: https://docs.openstack.org/releasenotes/coverage2sql
        
        Usage
        =====
        
        DB Setup
        --------
        
        The usage of coverage2sql is split into 2 stages. First you need to prepare a
        database with the proper schema; coverage2sql-db-manage should be used to do
        this. The utility requires db connection info which can be specified with a
        config file. Obviously the sql connector type, user,
        password, address, and database name should be specific to your environment.
        coverage2sql-db-manage will use alembic to setup the db schema. You can run the
        db migrations with a config file::
        
            coverage2sql-db-manage --config-file etc/coverage2sql.conf upgrade head
        
        This will bring the DB schema up to the latest version for coverage2sql.
        
        .. _coverage2sql:
        
        coverage2sql
        ------------
        
        Once you have a database setup with the proper database schema you can then use
        the coverage2sql command to populate the database with data from your test
        coverage file. coverage2sql takes in a `.coverage file`_ through by passing it
        file paths as positional arguments to the script at this moment.
        
        For example::
        
            coverage2sql --config-file etc/coverage2sql.conf coverage2sql .coverage
        
        .. _.coverage file: https://coverage.readthedocs.io/en/latest/cmd.html#data-file
        
        There are several options for running coverage2sql, they can be listed with::
        
            coverage2sql --help
        
        The only required option is ``--database-connection``. The options can either
        be used on the CLI, or put in a config file. If a config file is used you need
        to specify the location on the CLI.
        
        TODO
        ----
        
        To see the TODO, go to the launchpad site:
        
        * https://bugs.launchpad.net/coverage2sql
        * https://blueprints.launchpad.net/coverage2sql
        
        ChangeLog
        ---------
        
        To see the release notes go here: https://docs.openstack.org/releasenotes/coverage2sql/
        
        
Platform: UNKNOWN
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
