# ============================================================================
#
# Copyright (C) 2007-2016 Conceptive Engineering bvba.
# www.conceptive.be / info@conceptive.be
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of Conceptive Engineering nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# ============================================================================
import logging
from optparse import OptionParser
logging.basicConfig( level = logging.INFO )
LOGGER = logging.getLogger( 'camelot.bin.camelot_admin' )
#
# Description of the application, out of which the help text as well as the
# __doc__ strings can be generated
#
description = """camelot_admin is a tool to assist in the creation and development of Camelot
projects. Use this application without any options to start a GUI to create
a new Camelot project.
"""
usage = "usage: %prog [options] command"
command_description = [
('startproject', """Starts a new project, use startproject project_name.
"""),
('apidoc', """Extract API documentation from source code, to be used
with sphinx.
"""),
('license_update', """Change the license header of a project,
use license_update project_directory license_file"""),
]
#
# Generate a docstring in restructured text format
#
__doc__ = description
for command, desc in command_description:
__doc__ += "\n.. cmdoption:: %s\n\n" % command
for line in desc.split('\n'):
__doc__ += " %s\n" % line
#
# A custom OptionParser that generates help information on the commands
#
class CommandOptionParser(OptionParser):
def format_help(self, formatter=None):
command_help = """
The available commands are :
"""
command_help += '\n\n'.join(['%s\n%s\n%s'%(command,'-'*len(command), desc) for command,desc in command_description])
command_help += """
"""
return OptionParser.format_help(self) + ''.join(command_help)
def apidoc(source, destination):
import os
def is_module_directory( dirname ):
""":return: True if the directory is a python module, False otherwise"""
if not os.path.isdir( dirname ):
return False
if os.path.basename( dirname ).startswith( '.' ):
return False
return os.path.exists( os.path.join( dirname, '__init__.py' ) )
def document_directory(_arg, dirname, names):
"""create .rst files for a directory of source files"""
if is_module_directory( dirname ):
targetdir = os.path.join( destination, dirname[len(source)+1:] )
if not os.path.exists( targetdir ):
os.makedirs( targetdir )
srcs = [n for n in names if n.endswith('.py') and not n.startswith('__')]
dirs = [n for n in names if is_module_directory( os.path.join( dirname, n ) )]
title = os.path.basename( dirname )
if dirname == source:
title = '%s API'%(dirname.capitalize())
ifn = os.path.join( targetdir, 'index.rst' )
module_name = dirname.replace(os.path.sep, '.')
with open( ifn, 'w' ) as index:
lines = [ '=' * len(title),
title,
'=' * len(title),
'',
'',
'.. automodule:: %s'%module_name,
' :members:'
]
toclines = []
for sn in srcs:
sname = sn[:-3]
sfn = sname + '.rst'
toclines.append( ' %s'%sfn )
with open( os.path.join( targetdir, sfn ), 'w' ) as sf:
slines = ['-' * len(sname),
sname,
'-' * len(sname),
'',
'',
'.. automodule:: %s'%(module_name + '.' + sname),
' :members:', ]
sf.writelines( '%s\n'%line for line in slines )
toclines.extend( ' %s/index.rst'%dn for dn in dirs )
if toclines:
toclines.sort()
lines.extend( ['',
'.. toctree::',
''] )
lines.extend( toclines )
index.writelines( '%s\n'%line for line in lines )
LOGGER.info( '%s : %s -> %s'%(dirname, destination, targetdir) )
os.path.walk(source, document_directory, None)
def license_update(project, license_file):
import os
new_license = open(license_file).read()
def translate_file(dirname, name):
"""translate a single file"""
filename = os.path.join(dirname, name)
LOGGER.info( 'converting %s'%filename )
source = open(filename).read()
output = open(filename, 'w')
output.write(new_license)
old_license_line = True
for line in source.split('\n'):
if not len(line) or line[0]!='#':
old_license_line = False
if not old_license_line:
output.write(line)
output.write('\n')
def translate_directory(_arg, dirname, names):
"""recursively translate a directory"""
for name in names:
if name.endswith('.py'):
translate_file(dirname, name)
os.path.walk(project, translate_directory, None)
def startproject(module):
import os
from camelot.bin.meta import CreateNewProject, NewProjectOptions
if os.path.exists(module):
raise Exception('Directory %s already exists, cannot start a project in it'%module)
options = NewProjectOptions()
options.module = module
action = CreateNewProject()
action.start_project( options )
commands = locals()
def main():
import camelot
parser = CommandOptionParser( description = description,
usage = usage,
version = camelot.__version__, )
( _options, args ) = parser.parse_args()
if not len( args ):
meta()
elif not len( args )>=2:
parser.print_help()
else:
command, command_args = args[0], args[1:]
commands[command]( *command_args )
if __name__ == '__main__':
main()