index.lxp@lxpwrap=x8418_252ehtm.htm

GUI Programming with Python

>setup.py</TT
>.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
>MANIFEST.in</A
></H2
><P
>Despite the <TT
CLASS="VARNAME"
>data_files</TT
> option to
        <TT
CLASS="FUNCTION"
>setup()</TT
>, it is still necessary to provide
        a second file that contains a list of extra, non-Python
        files that need to be distributed. This file is called
        <TT
CLASS="FILENAME"
>MANIFEST.in</TT
> (mind the capitalization),
        and employs its own set of keywords to specify files to
        include or exclude.</P
><DIV
CLASS="EXAMPLE"
></A
><P
><B
>Example 26-3. MANIFEST.in</B
></P
><PRE
CLASS="SCREEN"
>include kalam
include kalam.bat
recursive-include data *
recursive-include pixmaps *
recursive-include dialogs *
        </PRE
></DIV
><P
>Here, we include the <TT
CLASS="FILENAME"
>kalam</TT
> starter script
        and the <TT
CLASS="FILENAME"
>kalam.bat</TT
> and batch file. Then we
        recursively include everything in the directories
        <TT
CLASS="FILENAME"
>data</TT
>, <TT
CLASS="FILENAME"
>pixmaps</TT
> and
        <TT
CLASS="FILENAME"
>dialogs</TT
>. (The latter is not absolutely
        necessary for running the application, but it can't hurt to
        give people access to our dialog designs.)</P
><P
>The options available for
        <TT
CLASS="FILENAME"
>MANIFEST.in</TT
> are:</P
><P
></P
><UL
><LI
><P
>include pat1 pat2 ...</P
></LI
><LI
><P
>exclude pat1 pat2 ...</P
></LI
><LI
><P
>recursive-include dir pat1 pat2 ...</P
></LI
><LI
><P
>recursive-exclude dir pat1 pat2 ...</P
></LI
><LI
><P
>global-include pat1 pat2 ...</P
></LI
><LI
><P
>global-exclude pat1 pat2 ...</P
></LI
><LI
><P
>prune dir</P
></LI
><LI
><P
>graft dir</P
></LI
></UL
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
>setup.cfg</A
></H2
><P
>The <TT
CLASS="FILENAME"
>setup.py</TT
> script takes myriad
        command-line options. You can also create a
        <TT
CLASS="FILENAME"
>setup.cfg</TT
> file that contains the most
        important options. Amongst those options are a number that tell the
        installer to install the application in a
        specific place. The user might need to edit these to reflect
        his preferences. For Unix, a good default is:
      </P
><PRE
CLASS="PROGRAMLISTING"
>[install]
install_lib=/usr/local/share/kalam
install_data=/usr/local/share/kalam
install_scripts=/usr/local/bin
      </PRE
><P
>All Python files (everything that is mentioned in the
        <TT
CLASS="VARNAME"
>py_modules</TT
> or <TT
CLASS="VARNAME"
>packages</TT
>
        argument in <TT
CLASS="FILENAME"
>setup.py</TT
>) will be installed
        in the install_lib directory. Everything that is mentioned in
        the <TT
CLASS="VARNAME"
>data_files</TT
> argument will be installed
        in the install_data directory. Likewise, everything that is
        included in the <TT
CLASS="VARNAME"
>scripts</TT
> argument will be
        installed in install_scripts.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
>Creating the source distribution</A
></H2
><P
>We are now ready to create the source distribution. This is a
        simple, one-line command:</P
><PRE
CLASS="SCREEN"
>boud@calcifer:~/src/kalam &#62; python setup.py sdist
      </PRE
><P
>The distutils will then spew a lot of text on the screen,
        and deliver your package in a subdirectory named
        <TT
CLASS="FILENAME"
>dist</TT
>:</P
><PRE
CLASS="SCREEN"
>boudewijn@maldar:~/doc/pyqt/ch18/kalam &#62; python setup.py sdist
running sdist
reading manifest template 'MANIFEST.in'
writing manifest file 'MANIFEST'
creating kalam-1.0
creating kalam-1.0/charmap
creating kalam-1.0/data
creating kalam-1.0/dialogs
creating kalam-1.0/kalamlib
creating kalam-1.0/pixmaps
creating kalam-1.0/typometer
creating kalam-1.0/workspace
making hard links in kalam-1.0...
hard linking README -&#62; kalam-1.0
hard linking edmund.py -&#62; kalam-1.0
hard linking kalam -&#62; kalam-1.0
hard linking kalam.bat -&#62; kalam-1.0
hard linking setup.cfg -&#62; kalam-1.0
hard linking setup.py -&#62; kalam-1.0
hard linking sitecustomize.py -&#62; kalam-1.0
hard linking startup.py -&#62; kalam-1.0
hard linking charmap/__init__.py -&#62; kalam-1.0/charmap
hard linking charmap/charmap.py -&#62; kalam-1.0/charmap
hard linking data/Blocks.txt -&#62; kalam-1.0/data
hard linking dialogs/frmfindreplace.ui -&#62; kalam-1.0/dialogs
hard linking dialogs/frmsettings.ui -&#62; kalam-1.0/dialogs
hard linking kalamlib/__init__.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/configtest.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/dlgfindreplace.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/dlgsettings.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/docmanager.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/docmanagertest.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/frmfindreplace.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/frmsettings.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/kalamapp.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/kalamconfig.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/kalamdoc.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/kalamview.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/macromanager.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/macromanagertest.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/main.py -&#62; kalam-1.0/kalamlib
hard linking kalamlib/resources.py -&#62; kalam-1.0/kalamlib
hard linking pixmaps/fileprint.xpm -&#62; kalam-1.0/pixmaps
hard linking pixmaps/find.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/listspace.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/listspace.xpm -&#62; kalam-1.0/pixmaps
hard linking pixmaps/splitspace.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/splitspace.xpm -&#62; kalam-1.0/pixmaps
hard linking pixmaps/stackspace.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/stackspace.xpm -&#62; kalam-1.0/pixmaps
hard linking pixmaps/tabmanager.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/tabmanager.xpm -&#62; kalam-1.0/pixmaps
hard linking pixmaps/workspace.png -&#62; kalam-1.0/pixmaps
hard linking pixmaps/workspace.xpm -&#62; kalam-1.0/pixmaps
hard linking typometer/__init__.py -&#62; kalam-1.0/typometer
hard linking typometer/typometer.py -&#62; kalam-1.0/typometer
hard linking workspace/__init__.py -&#62; kalam-1.0/workspace
hard linking workspace/listspace.py -&#62; kalam-1.0/workspace
hard linking workspace/splitspace.py -&#62; kalam-1.0/workspace
hard linking workspace/stackspace.py -&#62; kalam-1.0/workspace
hard linking workspace/tabmanager.py -&#62; kalam-1.0/workspace
hard linking workspace/workspace.py -&#62; kalam-1.0/workspace
creating dist
tar -cf dist/kalam-1.0.tar kalam-1.0
gzip -f9 dist/kalam-1.0.tar
removing 'kalam-1.0' (and everything under it)
boudewijn@maldar:~/doc/pyqt/ch18/kalam &#62;
      </PRE
><P
>That's it&#8212;a nice, clean and complete source distribution
        of <SPAN
CLASS="APPLICATION"
>Kalam</SPAN
>. You can generate both zip
        archives and gzipped tarballs by providing options on the
        command line:</P
><PRE
CLASS="SCREEN"
>boudewijn@maldar:~/doc/pyqt/ch18/kalam &#62; python setup.py sdist  --formats=gztar,zip
      </PRE
><P
>The options are zip, gztar, bztar, ztar and tar, for
        zipfiles, gzipped tarfiles, bzipped tarfiles, compressed
        tarfiles and plain tar files.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
>Installing a source archive</A
></H2
><P
>Installing a source archive is a simple matter of
        unpacking the archive and executing the following command:</P
><PRE
CLASS="SCREEN"
> boudewijn@maldar:~/doc/pyqt/ch18/kalam/dist/kalam-1.0 &#62; python setup.py install
      </PRE
><P
>Distutils will copy everything to the location
        designated in <TT
CLASS="FILENAME"
>setup.cfg</TT
>, and
        <SPAN
CLASS="APPLICATION"
>kalam</SPAN
> will be ready to run!.</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A accesskey="P" href="index.lxp@lxpwrap=x8401_252ehtm.htm">Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A accesskey="H" href="index.lxp@lxpwrap=book1_252ehtm">Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A accesskey="N" href="index.lxp@lxpwrap=x8580_252ehtm.htm">Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Packaging source</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A accesskey="U" href="index.lxp@lxpwrap=c8349_252ehtm.htm">Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Creating Unix RPM packages</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
      </td>
      </tr>
      </table>
      </td>
    </tr>
  </table>