Skip to content

docs: Refactor README and update Python version compatibility - #88

Merged
openrec0n merged 5 commits into
mainfrom
dev
Dec 17, 2025
Merged

docs: Refactor README and update Python version compatibility#88
openrec0n merged 5 commits into
mainfrom
dev

Conversation

@openrec0n

@openrec0n openrec0n commented Dec 16, 2025

Copy link
Copy Markdown
Collaborator

This PR includes comprehensive documentation improvements, Python version compatibility updates, and dependency constraint enhancements to improve maintainability and user experience.

Key Changes

Documentation Improvements

  • Complete README.md refactor:
    • Restructured with clearer sections and improved navigation
    • Added visual badges (version, license, platforms, techniques)
    • Expanded feature descriptions and getting started guide
    • Added architecture overview and platform capabilities table
    • Improved formatting and readability throughout

Python Version Compatibility

  • Updated README to support Python 3.8.x - 3.13.x (expanded from 3.8.x - 3.12.x)

Dependency Updates

Updated package constraints in requirements.txt:

  • cffi: >=1.17.0
  • cryptography: >=43.0.0
  • numpy: >=1.26.4,<2.0.0
  • pandas: >=2.2.3,<3.0.0
  • scipy: >=1.13.0

Summary

  • Improved documentation structure and clarity for better user onboarding
  • Maintained compatibility with Python 3.8-3.13
  • Updated dependencies for security and compatibility
  • No breaking changes to core functionality

Testing

  • Verified Docker builds with Python 3.11
  • Confirmed dependency resolution
  • Validated README formatting and links

@openrec0n
upgrade python version
3b0b16e
@openrec0n
refactor(readme): Update readme
610d20c
@openrec0n
Add Python 3.13 compatibility to requirements.txt
20b5e87 
Update package versions to support Python 3.13 while maintaining
backward compatibility with Python 3.8-3.12.

Package updates:
- numpy: 1.26.3 → >=1.26.4,<2.0.0
- pandas: 2.2.0 → >=2.2.3,<3.0.0
- scipy: 1.12.0 → >=1.13.0
- cffi: 1.16.0 → >=1.17.0
- cryptography: unpinned → >=43.0.0

Tested and verified with Python 3.9, 3.12, and 3.13.
@openrec0n
Revert "upgrade python version"
668b9bb 
This reverts commit 3b0b16e.
@openrec0n
Update README to support Python 3.13
30f9ee7
@openrec0n openrec0n self-assigned this Dec 16, 2025
@openrec0n openrec0n added documentation Improvements or additions to documentation enhancement New feature or request wip A work in progress. Help or additional review needed dependencies Pull requests that update a dependency file labels Dec 16, 2025
@openrec0n openrec0n changed the title Dev docs: Refactor README and update Python version compatibility Dec 17, 2025
@openrec0n openrec0n linked an issue Dec 17, 2025 that may be closed by this pull request
Python 3.13 Compatibility Issue #89
Closed
@openrec0n
openrec0n merged commit 61cbc76 into main Dec 17, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@openrec0n openrec0n

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request wip A work in progress. Help or additional review needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Python 3.13 Compatibility Issue

1 participant

@openrec0n