core-data-structures#

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

PyPI Downloads Python Versions License Pipeline Status Docs Status Security

Documentation Contents#

Index:

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

    • __iter__ (in-order), __len__, and __contains__ support

    • BinaryTree is a container over a Node-based structure (data_structures.trees.base.Node), mirroring the list implementations’ node pattern

  • Lists — singly and doubly linked lists sharing a common IList/ILinkedList interface.

    • Value-based CRUD: append, prepend, insert, get/__getitem__, index, pop/pop_front/pop_back, remove (single or all occurrences)

    • reverse, extend, clear, to_list/from_list

    • __iter__/__contains__ support, plus O(1) head/end node access

    • DoubleLinkedList additionally maintains .prev links for backward traversal and locates positions from whichever end (head/end) is closer

Installation#

Install from PyPI using pip:

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:

pip install --upgrade pip
pip install virtualenv

  1. Create Python virtual environment:

virtualenv --python=python3.12 .venv

  1. Activate the virtual environment:

source .venv/bin/activate

Install packages#

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

Check tests and coverage#

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.

Support#

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

Authors#