Python eggs, zc.buildout, zopeproject and zope3

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

Darryl Cousins
info@tfws.org.nz

Tree Fern Web Services

New Zealand Python User Group meeting, February 2008

Darryl Cousins info@tfws.org.nz (Tree Fern Web Services) Zope3 NZPUG February 2008 1 / 25

Eggs

A Python Module

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


Eggs

A Python Module: hello.py

def helloworld():
print uquot;Hello Worldquot;


Eggs

A Python Module: hello.py

def helloworld():
print uquot;Hello Worldquot;

We can import the method from the module:
from hello import helloworld


Eggs

A Python Package: hello

A package is a module that contains other modules:
hello/
__init__.py
hello.py


Eggs

A Python Package: hello

A package is a module that contains other modules:
hello/
__init__.py
hello.py

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


Eggs

Distutils

Distutils was written so we have a uniﬁed way to install python modules.
python setup.py install


Eggs

Distutils - creating a distribution

To distribute the hello module we need have it in a directory with a setup.py
ﬁle.

workingdir/
setup.py
hello/
__init__.py
hello.py


Eggs

Distutils - creating a distribution

To distribute the hello module we need have it in a directory with a setup.py
ﬁle.

workingdir/
setup.py
hello/
__init__.py
hello.py

The setup.py ﬁle needs at the least the following.
from distutils.core import setup

setup(name=quot;helloquot;,
)


Eggs

Distutils - creating a distribution, continued
Now we can create a distribution tarball with disutils.
python setup.py sdist


Eggs

Our directory now looks like this
workingdir/
setup.py
hello/
__init__.py
hello.py
dist/
hello-1.0.tar.gz


Eggs

Our directory now looks like this
workingdir/
setup.py
hello/
__init__.py
hello.py
dist/
hello-1.0.tar.gz
If we unpack the source distribution it looks like this:
hello-1.0/
PKG-INFO
setup.py
hello/
__init__.py
hello.py

Eggs

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


Eggs

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.py
python ez_setup.py


Eggs

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

from setuptools import setup

version=quot;1.0quot;,
)


Eggs

Eggs


)

We can call that with:
python setup.py bdist_egg


Eggs

Eggs


)

We can call that with:

Which creates a binary egg in our dist directory

dist/
hello-1.0-py2.4.egg


Eggs

Pypi

If we want that egg available on pypi and we have an account we can do that
with a single command.
python setup.py sdist upload


Eggs

Pypi

If we want that egg available on pypi and we have an account we can do that
with 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 conﬁguring repeatable steps for assembling
complicated systems (applications) from multiple parts.


zc.buildout

zc.buildout - what is it?

• Buildout is a system of conﬁguring repeatable steps for assembling
complicated 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.egg
interpreter = py
eggs = hello


zc.buildout

So - how to get started with Zope3

• Download tarball.


zc.buildout


• Download tarball. Wrong!


zc.buildout


• Download tarball. Wrong!
• Use zopeproject


zc.buildout

Virtual Environment

virtualenv nzpug


zc.buildout

Virtual Environment

virtualenv nzpug

cd nzpug
./bin/easy_install zopeproject


zc.buildout

Virtual Environment

virtualenv nzpug

cd nzpug
./bin/easy_install zopeproject

bin/zopeproject nzpug
Enter user (Name of an initial administrator): darryl
Enter passwd (Password for .. ): secret
Enter eggs_dir (Location ..) [’/opt/buildout/eggs’]: **
Creating directory ./nzpug
Downloading zc.buildout..
Invoking zc.buildout..


zc.buildout

.buildout/default.cfg

[buildout]
eggs-directory=/opt/buildout/eggs
develop-eggs-directory=/opt/buildout/develop-eggs
download-cache=/opt/buildout/cache


zc.buildout

nzpug/buildout.cfg

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


zc.buildout

nzpug/buildout.cfg

[buildout]
develop = .
parts = app test
find-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]
eggs = nzpug
zope.app.apidoc
zope.app.securitypolicy
z3c.evalexception>=2.0
Paste
PasteScript
PasteDeploy
interpreter = python


zc.buildout

nzpug/buildout.cfg (continued)

[app]
eggs = nzpug
zope.app.apidoc
zope.app.securitypolicy
z3c.evalexception>=2.0
Paste
PasteScript
PasteDeploy
interpreter = python

[test]
recipe = zc.recipe.testrunner
eggs = nzpug
defaults = [’--tests-pattern’, ’^f?tests$’, ’-v’]


zc.buildout

Directory contents

bin/
log/
parts/
src/
var/
apidoc.zcml
buildout.cfg
debug.ini
deploy.ini
setup.py
site.zcml
zdaemon.conf
zope.conf


zc.buildout

What’s in the bin directory?

buildout
nzpug-ctl
nzpug-debug
paster
python
static-apidoc
test


zc.buildout

nzpug/deploy.ini

[app:main]
use = egg:nzpug

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


zc.buildout

What’s in the src/nzpug directory?

__init__.py
configure.zcml
ftesting.zcml
startup.py
testing.py


zc.buildout

A HelloWorld - step 1: The template

hello.pt
<html i18n:domain=quot;nzpugquot;>
<head>
<title i18n:translate=quot;quot;>Hello World</title>
</head>
<body i18n:translate=quot;quot;>
Hello World
</body>
</html>


zc.buildout

A HelloWorld - step 2: The registration
conﬁgure.zcml
<configure xmlns=quot;http://namespaces.zope.org/zopequot;
xmlns:browser=quot;http://namespaces.zope.org/browserquot;
i18n_domain=quot;nzpugquot;>

<page
for=quot;*quot;
name=quot;helloquot;
permission=quot;zope.Publicquot;
template=quot;hello.ptquot;
/>

</configure>


zc.buildout

conﬁgure.zcml

<page
for=quot;*quot;
/>

</configure>

./bin/nzpug-ctl fg


zc.buildout

conﬁgure.zcml

<page
for=quot;*quot;
/>

</configure>

./bin/nzpug-ctl fg

http://localhost:8080/hello
Hello World

zc.buildout

Hello who?
hello.pt

<head>
</head>
Hello <span
tal:replace=quot;view/request/who|defaultquot;
>World</span>
</body>
</html>


zc.buildout

Hello who?
hello.pt

<head>
</head>
Hello <span
tal:replace=quot;view/request/who|defaultquot;
>World</span>
</body>
</html>

./bin/nzpug-ctl fg

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


zc.buildout

Create a distribution of our app



zc.buildout

Create a distribution of our app


ls dist
nzpug-0.1-py2.4.egg


Python eggs, zc.buildout, zopeproject and zope3

Recommended

Recommended

More Related Content

Recently uploaded

Recently uploaded (20)

Featured

Featured (20)

Python eggs, zc.buildout, zopeproject and zope3