Starting your first package


Create your python env and install it from PyPI:

pip install uiro

First project

After installing Uiro, ‘gearbox’ command will be available on your env. You can manage projects and applications by using this command. Now let’s create your first Uiro package:

gearbox create -n packagename

Above ‘packagename’ string should be replaced to some another name you want.

And then install created package:

cd packagename
python develop

This action makes your created package available on your env.

Then create SQLite DB as a file named ‘default.db’ to current dir:

gearbox initdb

The setting for DB is written in development.ini, and some another setting too, check it out.

Finally, you can serve your application, by serve command:

gearbox serve

Then, you can run your web browser and access to localhost with port 8888 to confirm automatically created package is running.

What files are in your package?

Your package must contain these packages:

├── packagename
│   ├──
│   ├──
│   ├──
│   ├──
│   ├── templates
│   │   └── top.mako
│   └── static
│       └── uiro.css
├── development.ini
├── README.rst
├── CHANGES.txt

Module to store Controllers which bundles each Views.

See Writing your views documentation.

Entry point for each Controllers, specifying which Controller should be called corresponds to URL gave by clients.

See URL Dispatching documentation.

Module to store Models, which is abstraction layer for structuring and manipulating the database. Uiro framework depends on SQLAlchemy, you can write your own Models by SQLAlchemy more easily.

See Connectiong to RDBs using SQLAlchemy documentation.


Directory to store mako templates. Templates will be collected automatically. The top.mako template can be picked up as a signature like ‘packagename:top.mako’.

See Using mako templates documentation.


Directory to store static files. Static files will be also collected automatically and served, so you should not handle them manually. The uiro.css file will be in /static/packagename/uiro.css, and the link can be generated, using request.matching.

See Serving static files documentation.


Configation file for WSGI application. It specifies that which Matching to use, which Database to connect and so on.

See Application configuration documentation.

Builder your package, which usually tells you that the module/package you are about to install have been packaged and distributed.

See setuptools documentation.

File to specify which file should be contained in package.


Text file to describe your package’s change logs.


README file for your package.

Table Of Contents

Previous topic

Uiro framework documentation

Next topic

Writing your views