Skip to content

Add README with Windows and C++ backend limitations #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PranjalSingh-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add README with Windows and C++ backend limitations #710

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions pydatastructs/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# PyDataStructs

PyDataStructs is a Python library providing implementation of various data structures and algorithms, including optional C++ backend support for performance-critical components.

## Project Status

The project contains both Python implementations as well as components tha rely on compiled C++ extensions.

### Windows Support

On Windows systems, tests that depend on C++ backend may fail due to missing compiled extensions . This behavior has been seen and observed across Python 3.11.9 and Python 3.13.2 .

Pure-Python data structures (such as linear data structures,trees,and strings) function as expected on Windows.

Users working on Windows are recommended to:
- Focus on pure-python components
- Skip C++ backend-dependent tests
- Use Linux environments if full backend testing is required

## Development Notes
- Python virtual environment are stongly recommended
- Some test failures on Windows are expected and documented
- Contributions improving cross-platform support are welcome
Loading