Python eggs, zc.buildout, zopeproject and zope3

Eggs, zc.buildout and Zope3Getting started with eggs, zc.buildout and Zope3

Darryl [email protected]

Tree Fern Web Services

New Zealand Python User Group meeting, February 2008

Darryl Cousins [email protected] (Tree Fern Web Services) Zope3 NZPUG February 2008 1 / 25

A Python Module

• A block of code which may imported by some other code.

A Python Module: hello.py

def helloworld():print u"Hello World"

We can import the method from the module:

from hello import helloworld

A Python Module: hello.py

def helloworld():print u"Hello World"

We can import the method from the module:

from hello import helloworld

A Python Package: hello

A package is a module that contains other modules:

hello/__init__.pyhello.py

Now we must import the method from the module within the module.

from hello.hello import helloworld

A Python Package: hello

A package is a module that contains other modules:

hello/__init__.pyhello.py

Now we must import the method from the module within the module.

from hello.hello import helloworld

Distutils

Distutils was written so we have a unified way to install python modules.

python setup.py install

Distutils - creating a distribution

To distribute the hello module we need have it in a directory with a setup.pyfile.

workingdir/setup.pyhello/

__init__.pyhello.py

The setup.py file needs at the least the following.

from distutils.core import setup

setup(name="hello",)

Distutils - creating a distribution

To distribute the hello module we need have it in a directory with a setup.pyfile.

__init__.pyhello.py

The setup.py file needs at the least the following.

from distutils.core import setup

setup(name="hello",)

Distutils - creating a distribution, continuedNow we can create a distribution tarball with disutils.

python setup.py sdist

Our directory now looks like this

__init__.pyhello.py

dist/hello-1.0.tar.gz

If we unpack the source distribution it looks like this:

hello-1.0/PKG-INFOsetup.pyhello/

__init__.pyhello.py

Setuptools

• Setuptools is built on top of distutils

• uses the setup.py

• uses eggs for distribution

• allows us to save our modules as eggs to pypi

Installing setuptools

wget http://peak.telecommunity.com/dist/ez_setup.pypython ez_setup.py

Setuptools

• Setuptools is built on top of distutils

• uses the setup.py

• uses eggs for distribution

• allows us to save our modules as eggs to pypi

Installing setuptools

wget http://peak.telecommunity.com/dist/ez_setup.pypython ez_setup.py

To create an egg change the import line in setup.py

from setuptools import setup

setup(name="hello",version="1.0",)

We can call that with:

python setup.py bdist_egg

Which creates a binary egg in our dist directory

dist/hello-1.0-py2.4.egg

If we want that egg available on pypi and we have an account we can do thatwith a single command.

python setup.py sdist upload

Which all the world can use

easy_install hello

If we want that egg available on pypi and we have an account we can do thatwith a single command.

python setup.py sdist upload

Which all the world can use

easy_install hello

zc.buildout

zc.buildout - what is it?

• Buildout is a system of configuring repeatable steps for assemblingcomplicated systems (applications) from multiple parts.

• A real world example of my own includes:• apache• postgresql• ramdb• zope3• sqlalchemy• pyxml• egenix-mx-base• psycopg2

zc.buildout

zc.buildout - what is it?

• Buildout is a system of configuring repeatable steps for assemblingcomplicated systems (applications) from multiple parts.

• A real world example of my own includes:• apache• postgresql• ramdb• zope3• sqlalchemy• pyxml• egenix-mx-base• psycopg2

zc.buildout

Example buildout.cfg

[buildout]develop = .parts = py

[py]recipe = zc.recipe.egginterpreter = pyeggs = hello

zc.buildout

So - how to get started with Zope3

• Download tarball.

Wrong!

• Use zopeproject

zc.buildout

• Download tarball. Wrong!

• Use zopeproject

zc.buildout

• Download tarball. Wrong!

• Use zopeproject

zc.buildout

Virtual Environment

virtualenv nzpug

cd nzpug./bin/easy_install zopeproject

bin/zopeproject nzpugEnter user (Name of an initial administrator): darrylEnter passwd (Password for .. ): secretEnter eggs_dir (Location ..) [’/opt/buildout/eggs’]: **Creating directory ./nzpugDownloading zc.buildout..Invoking zc.buildout..

zc.buildout

Virtual Environment

virtualenv nzpug

zc.buildout

Virtual Environment

virtualenv nzpug

zc.buildout

.buildout/default.cfg

[buildout]eggs-directory=/opt/buildout/eggsdevelop-eggs-directory=/opt/buildout/develop-eggsdownload-cache=/opt/buildout/cache

zc.buildout

nzpug/buildout.cfg

[buildout]develop = .parts = app testfind-links = http://download.zope.org/distribution/newest = false# eggs will be installed in the default buildout location# (see ~/.buildout/default.cfg)

extends = http://download.zope.org/zope3.4/versions-3.4.0.cfg

zc.buildout

nzpug/buildout.cfg

[buildout]develop = .parts = app testfind-links = http://download.zope.org/distribution/newest = false# eggs will be installed in the default buildout location# (see ~/.buildout/default.cfg)

extends = http://download.zope.org/zope3.4/versions-3.4.0.cfg

zc.buildout

nzpug/buildout.cfg (continued)

[app]recipe = zc.recipe.eggeggs = nzpug

zope.app.apidoczope.app.securitypolicyz3c.evalexception>=2.0PastePasteScriptPasteDeploy

interpreter = python

[test]recipe = zc.recipe.testrunnereggs = nzpugdefaults = [’--tests-pattern’, ’^f?tests$’, ’-v’]

zc.buildout

nzpug/buildout.cfg (continued)

[app]recipe = zc.recipe.eggeggs = nzpug

zope.app.apidoczope.app.securitypolicyz3c.evalexception>=2.0PastePasteScriptPasteDeploy

interpreter = python

[test]recipe = zc.recipe.testrunnereggs = nzpugdefaults = [’--tests-pattern’, ’^f?tests$’, ’-v’]

zc.buildout

Directory contents

bin/log/parts/src/var/apidoc.zcmlbuildout.cfgdebug.inideploy.inisetup.pysite.zcmlzdaemon.confzope.conf

zc.buildout

What’s in the bin directory?

buildoutnzpug-ctlnzpug-debugpasterpythonstatic-apidoctest

zc.buildout

nzpug/deploy.ini

[app:main]use = egg:nzpug

[server:main]use = egg:Paste#httphost = 127.0.0.1port = 8080

zc.buildout

What’s in the src/nzpug directory?

__init__.pyconfigure.zcmlftesting.zcmlstartup.pytesting.py

zc.buildout

A HelloWorld - step 1: The template

hello.pt

<title i18n:translate="">Hello World</title></head><body i18n:translate="">

Hello World</body>

</html>

zc.buildout

A HelloWorld - step 2: The registration

configure.zcml

<pagefor="*"name="hello"permission="zope.Public"template="hello.pt"

</configure>

./bin/nzpug-ctl fg

http://localhost:8080/helloHello World

zc.buildout

configure.zcml

</configure>

./bin/nzpug-ctl fg

zc.buildout

configure.zcml

</configure>

./bin/nzpug-ctl fg

zc.buildout

Hello who?

hello.pt

Hello <spantal:replace="view/request/who|default">World</span>

</body></html>

./bin/nzpug-ctl fg

http://localhost:8080/hello?who=DarrylHello Darryl

zc.buildout

Hello who?

hello.pt

Hello <spantal:replace="view/request/who|default">World</span>

</body></html>

./bin/nzpug-ctl fg

http://localhost:8080/hello?who=DarrylHello Darryl

zc.buildout

Create a distribution of our app

ls distnzpug-0.1-py2.4.egg

zc.buildout

Create a distribution of our app

ls distnzpug-0.1-py2.4.egg

Python eggs, zc.buildout, zopeproject and zope3

Technology

Transcript of Python eggs, zc.buildout, zopeproject and zope3