Skip to content

Refactor: Relocate fspin_cheatsheet.md under fspin directory and …#44

Merged
Suke0811 merged 2 commits intomainfrom
patch-for-missing-doc-in-pypi
Jan 5, 2026
Merged

Refactor: Relocate fspin_cheatsheet.md under fspin directory and …#44
Suke0811 merged 2 commits intomainfrom
patch-for-missing-doc-in-pypi

Conversation

@Suke0811
Copy link
Owner

@Suke0811 Suke0811 commented Jan 5, 2026

This pull request updates how the fspin_cheatsheet.md file is bundled and accessed within the fspin package to improve compatibility and reliability across different Python versions and installation methods. The main focus is on using importlib.resources for cheatsheet access and ensuring the cheatsheet is correctly included in package distributions.

Packaging and resource access improvements:

  • Updated MANIFEST.in to include fspin_cheatsheet.md from within the fspin directory, ensuring the cheatsheet is packaged correctly.
  • Added include_package_data=True in setup.py to make sure package data files like the cheatsheet are included during installation.

Cheatsheet loading logic enhancements:

  • Refactored fspin/__main__.py to use importlib.resources for reading fspin_cheatsheet.md, providing compatibility with both modern and older Python versions, and added a fallback to load the file from the local filesystem if necessary.…update manifest accordingly.

@Suke0811 Suke0811 merged commit 4bd3a51 into main Jan 5, 2026
8 checks passed
@Suke0811 Suke0811 deleted the patch-for-missing-doc-in-pypi branch January 5, 2026 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant