Usage
===============

Installation
************

To get started, install ``beartools``::

    pip install beartools --index-url https://gitlab.unco.edu/api/v4/projects/557/packages/pypi/simple


Getting Started
***************

Hashing Files
~~~~~~~~~~~~~

.. code-block:: python

    from beartools.fileio.hash import hash_file

    print(hash_file("path/to/file"))

This will output the sha3_512 hash of the specified file. For more info, see the :ref:`API Reference`.

Oracle Factories
~~~~~~~~~~~~~~~~

.. code-block:: python

    from beartools.oracle.factories import dict_factory
    
    # Assuming you already have an oracledb or cx_Oracle cursor
    cursor.execute(query)
    cursor.rowfactory = dict_factory(cursor)
    results = cursor.fetchall()
    # Results will be a list of dictionaries