use_npm_readme.py

"""
use-npm-readme.py

This script handles the README file swapping process for npm publishing.

After the README_npm_output.md file is generated by the conversion script, this script is run by the `prepublish` hook, which (temporarily) replaces the main README with the npm version. After publishing, the original README is restored.
"""

import os
import shutil
import sys
import argparse


def prepare_for_publish():
    """
    Prepare README for npm publishing by replacing it with the npm-compatible version.
    """
    # Backup the original README if it hasn't been backed up already
    if os.path.exists('README.md') and not os.path.exists('.original-readme.md'):
        shutil.copy2('README.md', '.original-readme.md')
        print("Original README backed up as .original-readme.md")
    
    # Use the npm version as the main README
    if os.path.exists('README_npm_output.md'):
        shutil.copy2('README_npm_output.md', 'README.md')
        print("NPM README is now in place for publishing")
    else:
        print("Error: README_npm_output.md not found. Run the conversion script first.")
        sys.exit(1)


def restore_after_publish():
    """
    Restore the original README after npm publishing completes.
    """
    # Restore the original README
    if os.path.exists('.original-readme.md'):
        shutil.copy2('.original-readme.md', 'README.md')
        os.remove('.original-readme.md')
        print("Original README restored")
    else:
        print("Warning: No backed-up README found to restore")
    
    # Remove the temporary npm README
    if os.path.exists('README_npm_output.md'):
        os.remove('README_npm_output.md')
        print("Temporary npm README removed")


def main():
    parser = argparse.ArgumentParser(
        description='Manage README files for npm publishing process'
    )
    parser.add_argument(
        'action', 
        choices=['prepare', 'restore'],
        help='Action to perform: "prepare" before publishing or "restore" after'
    )
    
    args = parser.parse_args()
    
    if args.action == 'prepare':
        prepare_for_publish()
    elif args.action == 'restore':
        restore_after_publish()


if __name__ == "__main__":
    main()