setup.py

#!/usr/bin/env python
#
# This script is designed to  rename the default skeleton project name (myproject) and app (myfirstapp) to names you choose
#
import os, sys, string, shutil

CURRENT_DIRECTORY    = os.getcwd()
CURRENT_PROJECT_NAME = 'myproject'
CURRENT_APP_NAME     = 'myfirstapp'
GITHUB_CLONE_CMD     = 'git clone https://github.com/mschettler/django-skeleton.git'

BAR80 = '-'*100  # the cake is a lie

################################################################################
# Helper functions
################################################################################

def get_user_feedback():
    """ get user feedback, failing nicely if they kill it during input """
    try:
        return raw_input().strip()
    except KeyboardInterrupt:
        print 'The script was killed. Goodbye!'
        sys.exit(0)


def is_alphanumeric(instr):
    """ 
    return false if instr contains anything other than
    letters or numbers
    """
    allowed = string.letters + string.digits + '_' + '-'
    return not bool(set(instr) - set(allowed))


def validate_name(name):
    """ 
    returns None on success, otherwise an error message is returned describing
    why the name failed to validate
    """

    if ' ' in name:
        return 'Error: Name cannot contain spaces'
    
    if not is_alphanumeric(name):
        return 'Error: Name can only contain letters and numbers'

    if len(name) < 1:
        return 'Error: Name must have length'

    if name[0] in string.digits:
        return 'Error: Name cannot start with a digit'

    if name[0] in '_-':
        return 'Error: Name can only start with a letter, not an underscore or dash'


    # name passed validation
    return None


def get_folder_list_for_directory(path, ignorehidden=True):
    """ returns a list of dirs found at the given path """

    if not os.path.isdir(path):
        raise Exception('Invalid path "%s" passed to get_folder_list_for_directory(), does not appear to be a directory.') % path

    ret = [d for d in os.listdir(path) if os.path.isdir(d)]

    if ignorehidden:
        ret = [d for d in ret if not d.startswith('.')]

    return ret


def rename(oldpath, newpath):
    """ similar to os.rename, performs some additional checks """
    if not (oldpath and newpath):
        raise Exception('Failed to supply a paramter to rename()')
    if os.path.exists(newpath):
        raise Exception('Cannot rename, newpath [%s] already exists' % newpath)
    if not os.path.exists(oldpath):
        raise Exception('Cannot rename, oldpath [%s] does not exist' % old)

    print '%s: Renamed %s to %s' % (__file__, oldpath, newpath)
    shutil.move(oldpath, newpath)


def replace_text_infile(filepath, find, replace):
    if not (filepath and find):
        raise Exception('Failed to supply a parameter to replace_text_infile()')
    if not os.path.isfile(filepath):
        raise Exception('Cannot replace, filepath [%s] does not exists' % filepath)


    with open(filepath, 'r') as fh:
        fdata = fh.read()

    with open(filepath, 'w') as fh:
        print '%s: replaced text "%s" in file "%s" with text "%s"' % (__file__, find, filepath, replace)
        fh.write(fdata.replace(find, replace))


################################################################################
# Some sanity checks
################################################################################

# make sure we were executed from the proper directory
if not (CURRENT_DIRECTORY.endswith('django-skeleton') or 'mschettler-django-skeleton-' in CURRENT_DIRECTORY):
    print 'Error: Script cannot continue'
    print '    * We seem to be in directory "%s", but we need to be in the django-skeleton/ directory. Please navigate there and run this script again.' % CURRENT_DIRECTORY
    print '    * If you need to re-download a fresh copy of this repo, please execute the command "%s"' % GITHUB_CLONE_CMD
    sys.exit(1)


# lets see if we can find myproject
if not CURRENT_PROJECT_NAME in get_folder_list_for_directory(CURRENT_DIRECTORY):
    print 'Error: Script cannot continue'
    print '    * We failed to find "%s" in directory "%s". This might have happened because you already renamed the project.' % (CURRENT_PROJECT_NAME, CURRENT_DIRECTORY)
    print '    * This script depends on an exact file structure to work properly.'
    print '    * If you need to re-download a fresh copy of this repo, please execute the command "%s"' % GITHUB_CLONE_CMD
    sys.exit(1)


################################################################################
# Main script routine - get a new name for the project
################################################################################

inputerror = True

print BAR80
print 'Welcome to django-skeleton! This script will ask you for a project and first app name. Enjoy!'


while inputerror:

    print BAR80
    print 'Your current project name is "%s". Please enter a new outer project name (blank to skip): ' % CURRENT_PROJECT_NAME
    new_project_name = get_user_feedback()

    if new_project_name:
        inputerror = validate_name(new_project_name)
        if inputerror:
            print inputerror
            continue

        print 'You entered "%s" as your new project name.' % new_project_name
    else:
        print 'You skipped renaming your default project. The current name of "%s" still stands.' % CURRENT_PROJECT_NAME

    break

################################################################################
# Main script routine - get a new name for the app
################################################################################

inputerror = True

while inputerror:

    print BAR80

    print 'Your current default app name is "%s". Please enter a new app name (blank to skip): ' % CURRENT_APP_NAME
    new_app_name = get_user_feedback()

    if new_app_name:
        inputerror = validate_name(new_app_name)
        if inputerror:
            print inputerror
            continue

        print 'You entered "%s" as your new default app name.' % new_app_name
    else:
        print 'You skipped renaming your default app. The current name of "%s" still stands.' % CURRENT_APP_NAME

    break

print BAR80

if not new_app_name and not new_project_name:
    print 'You decided not to rename your project or app. This script has nothing to do. Goodbye!'
    sys.exit(0)


if new_app_name == new_project_name:
    print 'You must select different names for your project and first application. This script cannot continue.'
    sys.exit(1)
    

################################################################################
# Main script routine - build a list of files that need to be renamed
################################################################################

# this is a list of tuples, with (orig_path, dest_path)
# we cache all renames till the end, so we can print them out
# and confirm them with the user
rename_cache = []


# file string replace cache
# contains tuples, (path_to_file, find_string, replace_string)
file_string_replace = []

# walk the directory and perform renames
for root, dirs, files in os.walk(CURRENT_DIRECTORY):

    # ignore git metadata    
    if '.git' in root:
        continue

    if new_project_name and CURRENT_PROJECT_NAME in dirs+files:
        rename_cache.append((os.path.join(root, CURRENT_PROJECT_NAME), os.path.join(root, new_project_name)))
    if new_app_name and CURRENT_APP_NAME in dirs+files:
        rename_cache.append((os.path.join(root, CURRENT_APP_NAME), os.path.join(root, new_app_name)))

    # build a list of files that need to have strings replaced
    for f in files:

        fullpath = os.path.join(root, f)

        # ignore hidden files, this file, and non-python files
        if f.startswith('.') or f == __file__.lstrip('./') or not f.endswith('.py'):
            continue

        with open(fullpath, 'r') as fh:
            fdata = fh.read()

        if new_project_name and CURRENT_PROJECT_NAME in fdata:
            file_string_replace.append((fullpath, CURRENT_PROJECT_NAME, new_project_name))
        if new_app_name and CURRENT_APP_NAME in fdata:
            file_string_replace.append((fullpath, CURRENT_APP_NAME, new_app_name))


if not rename_cache:
    print 'Error: Script cannot continue'
    print '    * We did not find any files to rename. This is considered an error'
    print '    * If you need to re-download a fresh copy of this repo, please execute the command "%s"' % GITHUB_CLONE_CMD
    sys.exit(1)

# reverse this so execution renames the deepest directories first
rename_cache.reverse()

if not file_string_replace:
    print 'Error: Script cannot continue'
    print '    * We did not find any files in which to replace project/app text. This is considered an error'
    print '    * If you need to re-download a fresh copy of this repo, please execute the command "%s"' % GITHUB_CLONE_CMD
    sys.exit(1)


################################################################################
# Main script routine - tell user what we are about to do, and ask for feedback
################################################################################

# for trename in rename_cache:
#     print 'RENAME "%s" => "%s"' % trename


# for treplace in file_string_replace:
    # print 'MODIFY FILE "%s" REPLACE "%s" WITH "%s"' % treplace


# print 'We are about to rename %d files, and modify %d files. Please confirm that you would like to do this [y/n] (default y): ' % (len(rename_cache), len(file_string_replace))
# print 'We are about to modify %d files. Please confirm that you would like to do this [y/n] (default y): ' % (len(rename_cache) + len(file_string_replace))
# if 'n' in get_user_feedback().lower():
#     print 'Okay, we won\'t do anything. Goodbye!'
#     sys.exit(0)


################################################################################
# Main script routine - actually do all processing
################################################################################

print BAR80

# do text replace
for treplace in file_string_replace:
    replace_text_infile(*treplace) # unpack tuple

# do renames
for trename in rename_cache:
    rename(*trename) # unpack tuple


################################################################################
# Final sanity checks
################################################################################

if new_project_name and CURRENT_PROJECT_NAME in get_folder_list_for_directory(CURRENT_DIRECTORY):
    print 'Error: Script hit fatal error'
    print '    * It seems "%s" still exists after we were supposed to rename it. Not sure what happened... bailing...' % CURRENT_PROJECT_NAME
    print '    * If you need to re-download a fresh copy of this repo, please execute the command "%s"' % GITHUB_CLONE_CMD
    sys.exit(1)


################################################################################
# Offer to remove git metadata, README, and this file
################################################################################

print BAR80
print 'If you would like, we can remove the git metadata, github README.md, and this setup.py script'
print '    * This will leave django-skeleton as a clean folder with your fresh django project inside'
print 'Would you like to do this? [y/n] (default y): '
if 'n' in get_user_feedback().lower():
    print 'Okay, we won\'t remove metadata'
else:
    # remove metadata
    toremove = [os.path.join(CURRENT_DIRECTORY, 'setup.py'), os.path.join(CURRENT_DIRECTORY, 'README.md'), os.path.join(CURRENT_DIRECTORY, '.git'), os.path.join(CURRENT_DIRECTORY, '.gitignore'), os.path.join(CURRENT_DIRECTORY, 'screenshot.png')]

    for f in toremove:
        try:
            if os.path.isdir(f):
                shutil.rmtree(f)
            else:
                os.remove(f)
            print 'REMOVED "%s"' % f
        except:
            print 'FAILED TO REMOVE "%s"' % f


################################################################################
# Done!
################################################################################

print BAR80
print '* Your project is ready. Hope you enjoyed django-skeleton!'
print '* Please checkout my website http://mschettler.com or fork this repo at %s' % (GITHUB_CLONE_CMD.split(' ')[-1])
sys.exit(0)