UCXDSA Package
=============================================================

A collection of classes and functions for use in UC Berkeley Extension's 
Computer Science X404.1: Data Structures and Algorithms Class.

Overview
--------

This package is designed as an educational tool for students to learn and 
experiment with data structures and algorithms. It is written in Python with 
an emphasis on readability and clarity, rather than performance or optimization. 
**Not intended for production use.**

Project repository: `UCXDSA on GitHub <https://github.com/ucxinstructor/dsa_package>`_

Command Line Installation
-------------------------

.. code-block:: bash

   pip install ucxdsa

Updating an Existing Version
-----------------------------------------------

.. code-block:: bash

   pip install --upgrade ucxdsa

Determining Current Version
-----------------------------------------------
To determine the dsa package version, enter the following in Python or Jupyter:

.. code-block:: python

   import dsa
   print(dsa.version)

or from the terminal

.. code-block:: bash

   pip show ucxdsa

Quick Usage Guide
-----------------

.. code-block:: python

   from dsa.modulename import classname

Replace ``modulename`` and ``classname`` with the module and class to be used.

