Metadata-Version: 1.1
Name: scdatatools
Version: 0.1.2
Summary: Python tools for working with Star Citizen data files.
Home-page: https://github.com/ExterraGroup/scdatatools
Author: Ventorvar
Author-email: ventorvar@gmail.com
License: MIT license
Description: ===========
        scdatatools
        ===========
        
        
        .. image:: https://img.shields.io/pypi/v/scdatatools.svg
                :target: https://pypi.python.org/pypi/scdatatools
        
        .. image:: https://img.shields.io/travis/ExterraGroup/scdatatools.svg
                :target: https://travis-ci.org/ExterraGroup/scdatatools
        
        .. image:: https://readthedocs.org/projects/scdatatools/badge/?version=latest
                :target: https://scdatatools.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://coveralls.io/repos/github/ExterraGroup/scdatatools/badge.svg?branch=devel
                :target: https://coveralls.io/github/ExterraGroup/scdatatools?branch=devel
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
        
        
        Python API for interactive with the data files in Star Citizen.
        
        .. warning:: This toolsuite is in it's very early stages and will change often.
        
        * Free software: MIT license
        * Documentation: https://scdatatools.readthedocs.io.
        
        
        Features
        --------
        
        * cli interface
        * TODO
        
        
        CLI Examples
        ------------
        
        .. code-block:: bash
        
            scdt --help
            usage: scdt [-h] [--verbose] [--stderr] [--command-timeout COMMAND_TIMEOUT] [command] ...
        
            positional arguments:
              [command]             Subcommand to run, if missing the interactive mode is started instead.
                cryxml-to-json      Convert a CryXML file to JSON
                cryxml-to-xml       Convert a CryXML file to xml
                unforge             Convert a DataForge file to a readable format
                unp4k               Extract files from a P4K file
        
        API Examples
        ------------
        
        Read a DataForge database (.dcb)
        
        .. code-block:: bash
        
            from scdatatools.forge import DataCoreBinary
            dcb = DataCoreBinary('research/Game.dcb.3.9.1-ptu.5229583')
            jav_records = dcb.search_filename('*javelin.xml')
            print(dcb.dump_record_json(jav_records[-1]))
        
        =======
        History
        =======
        
        0.1.2 (2020-05-20)
        ------------------
        
        * Initial commit
        
Keywords: scdatatools
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
