.. core-data-structures documentation master file, created by
   sphinx-quickstart on Fri Apr  3 16:28:06 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

core-data-structures
==================================

A Python library providing common data structures including graphs and trees,
with built-in traversal and path-finding algorithms.

==================================

.. image:: https://img.shields.io/pypi/pyversions/core-data-structures.svg
    :target: https://pypi.org/project/core-data-structures/
    :alt: Python Versions

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-data-structures/-/blob/main/LICENSE
    :alt: License

.. image:: https://gitlab.com/bytecode-solutions/core/core-data-structures/badges/release/pipeline.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-data-structures/-/pipelines
    :alt: Pipeline Status

.. image:: https://readthedocs.org/projects/core-data-structures/badge/?version=latest
    :target: https://readthedocs.org/projects/core-data-structures/
    :alt: Docs Status

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security


Documentation Contents
-------------------------------------------------------------------------------

.. toctree::
   :maxdepth: 2
   :caption: Index:

   api/graphs
   api/trees


Features
-------------------------------------------------------------------------------

- **Graphs** — undirected weighted graph with adjacency dictionary representation.

  - Breadth-first search (BFS)
  - Depth-first search (DFS)
  - Path finding (single path, all paths, shortest path)

- **Trees** — binary tree and simple nested-dictionary tree.

  - Pre-order, in-order, post-order, and level-order traversal
  - Recursive and iterative variants
  - Tree depth calculation


Installation
-------------------------------------------------------------------------------

Install from PyPI using pip:

.. code-block:: bash

    pip install core-data-structures
    uv pip install core-data-structures   # Or using UV...
    pip install -e ".[dev]"               # For development...


Setting Up Environment
-------------------------------------------------------------------------------

1. Install required libraries:

.. code-block:: bash

    pip install --upgrade pip
    pip install virtualenv

2. Create Python virtual environment:

.. code-block:: bash

    virtualenv --python=python3.12 .venv

3. Activate the virtual environment:

.. code-block:: bash

    source .venv/bin/activate

Install packages
-------------------------------------------------------------------------------

.. code-block:: bash

    pip install .
    pip install -e ".[dev]"

Check tests and coverage
-------------------------------------------------------------------------------

.. code-block:: shell

    python manager.py run-tests
    python manager.py run-coverage


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

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Write tests for new functionality
4. Ensure all tests pass: ``python manager.py run-tests``
5. Run linting: ``pylint data_structures``
6. Run security checks: ``bandit -r data_structures``
7. Submit a pull request


License
-------------------------------------------------------------------------------

This project is licensed under the MIT License. See the LICENSE file for details.


Links
-------------------------------------------------------------------------------

* **Documentation:** https://core-data-structures.readthedocs.io/en/latest/
* **Repository:** https://gitlab.com/bytecode-solutions/core/core-data-structures
* **Issues:** https://gitlab.com/bytecode-solutions/core/core-data-structures/-/issues
* **Changelog:** https://gitlab.com/bytecode-solutions/core/core-data-structures/-/blob/master/CHANGELOG.md
* **PyPI:** https://pypi.org/project/core-data-structures/


Support
-------------------------------------------------------------------------------

For questions or support, please open an issue on GitLab or contact the maintainers.


Authors
-------------------------------------------------------------------------------

* **Alejandro Cora González** - *Initial work* - alek.cora.glez@gmail.com