Metadata-Version: 2.1
Name: yxdb
Version: 1.0.0
Summary: Reads Alteryx data files into Python
Author-email: tlarsendataguy <tom@tlarsendataguy.com>
License: MIT License
        
        Copyright (c) 2022 tlarsendataguy
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/tlarsendataguy-yxdb/yxdb-py
Project-URL: Bug Tracker, https://github.com/tlarsendataguy-yxdb/yxdb-py/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

## yxdb-py

yxdb-py is a library for reading YXDB files into Python.

install using `pip install yxdb`

The library does not have external dependencies and is a pure Python solution.

The public API is contained in the YxdbReader class. Instantiate YxdbReader with the following constructors:
* `YxdbReader(path=str)` - load from a file
* `YxdbReader(stream=BytesIO)` - load from an in-memory stream

Iterate through the records in the file using the `next()` method in a while loop:

```
while reader.next():
    # do something
```

Fields can be access via the `read_index()` and `read_name()` methods on the YxdbReader class.

The list of fields in the YXDB file can be access via the `list_fields()` method.
