mkpythonproj User Manual

Table of Contents

• Overview

Overview

NAME:
    mkpythonproj.py

SYNOPSIS:
    mkpythonproj.py [options] projname

DESCRIPTION:
    Make a new script or a new project, with licenses et al
    
OPTIONS:
    -h, --help             this message
    -v, --version          print version
    --author=xyz           set author to xyz
    --email=xyz            set author's email to xyz
    --url=xyz              set project's url to xyz
    --body=xyz             use body xyz [default_body]
    --pyexec=xyz           use #!xyz [/usr/bin/env python]
    --license=xyz          use license xyz [GPL]
    --script               make just a script, in current dir
    --doc                  make new document files; save old as .bak
    --setup                make new setup.py; save old as .bak
    --tests                make new pyunit-style test framework
    
EXAMPLES:
    Typically setup an alias:
       alias mkpyproj 'mkpythonproj.py --author="John Doe" \
           email="jdoe@example.com" url="http://www.example.com" \
           license="example_license" '

    1. Make a simple script
        mkpyproj --script myproj
       Makes a simple script:
        myproj.py

    2. Make a full project 
        mkpyproj myproj
       Makes a full project:
            AUTHORS
            COPYING
            MANIFEST.in
            README
            VERSION
            myproj/
              __init__.py
              myproj.py
            setup.py
            doc/
              go
              deshist.pdx,html
              devguide.pdx,html
              manual.prd,html
              index.pdx,html
            test/
              go              
              testdata/

    3. Make a new setup.py (needed if the setup process has changed)
        mkpyproj --setup myproj
       Makes:
          setup.py.bak   (the old one)
          setup.py       (the new one)
        
# Copyright (C) 2000,2001,2004  Harry George
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Library General Public License for more details.
#
# You should have received a copy of the GNU Library General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
#