This is a Python implementation of the celebrated Gale-Shapley Algorithm also known as the Deferred Acceptance Algorithm.

The time complexity of the algorithm is O(n^2) and the space complexity is O(n).

Developer Setup

This project is pdm-managed, which is compatible with PEP 582 and PEP 621. If you are a developer, first pip install pdm and then make your Python interpreter aware of PEP 582. You can do this by running

pdm --pep582 >> ~/.bash_profile

Then git clone the project and run pdm sync in the project directory.

The project also uses pre-commit hooks. You can pip install pre-commit and then run

pre-commit install

in the project directory to install hooks to your local .git.