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

A collection of data structures and algorithms implemented in Pythonfor use in UC Berkeley Extension's 
Computer Science X404.1: Data Structures and Algorithms Class.


Overview
--------

This package is an educational tool for students to learn and experiment with data structures and algorithms. It helps learners understand core concepts and allows developers to explore implementations.

Written in Python, the package emphasizes readability and clarity over 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.



Contributing
------------

We welcome contributions! You can help by:

- Reporting bugs or unexpected behavior
- Suggesting new features or improvements
- Submitting pull requests with code enhancements or documentation updates

How to Contribute
-----------------

1. Fork the repository.
2. Create a new branch for your changes.
3. Commit your changes with clear messages.
4. Submit a pull request explaining your changes.

Reporting Issues
----------------

Please use the  `GitHub Issues￼ page <https://github.com/ucxinstructor/dsa_package/issues>`_  to report any problems or request features. Provide detailed information so we can reproduce and address the issue efficiently.

Thank you for helping improve this project!

