author | Denis Laxalde <denis.laxalde@logilab.fr> |
Mon, 26 Sep 2016 10:17:10 +0200 | |
changeset 11687 | f9efc8012b64 |
parent 10517 | fa9a0c80556d |
child 11689 | 213f60272d49 |
permissions | -rw-r--r-- |
6928
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
1 |
Creating a new cube from scratch |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
2 |
-------------------------------- |
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
3 |
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
4 |
Let's start by creating the cube environment in which we will develop :: |
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
5 |
|
5400
b7ab099b128a
[doc/book] various content fixes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5394
diff
changeset
|
6 |
cd ~/cubes |
4437
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
7 |
# use cubicweb-ctl to generate a template for the cube |
5400
b7ab099b128a
[doc/book] various content fixes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5394
diff
changeset
|
8 |
# will ask some questions, most with nice default |
b7ab099b128a
[doc/book] various content fixes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5394
diff
changeset
|
9 |
cubicweb-ctl newcube mycube |
4437
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
10 |
# makes the cube source code managed by mercurial |
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
11 |
cd mycube |
4437
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
12 |
hg init |
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
13 |
hg add . |
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
14 |
hg ci |
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
15 |
|
2280
31269a9b9ec4
[doc] improvements
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2172
diff
changeset
|
16 |
If all went well, you should see the cube you just created in the list |
6928
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
17 |
returned by ``cubicweb-ctl list`` in the *Available cubes* section. |
5608
f9ab62103ad4
proof read documentation
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
5400
diff
changeset
|
18 |
If not, please refer to :ref:`ConfigurationEnv`. |
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
19 |
|
5400
b7ab099b128a
[doc/book] various content fixes
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5394
diff
changeset
|
20 |
To reuse an existing cube, add it to the list named |
5608
f9ab62103ad4
proof read documentation
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
5400
diff
changeset
|
21 |
``__depends_cubes__`` which is defined in :file:`__pkginfo__.py`. |
f9ab62103ad4
proof read documentation
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
5400
diff
changeset
|
22 |
This variable is used for the instance packaging (dependencies handled |
f9ab62103ad4
proof read documentation
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
5400
diff
changeset
|
23 |
by system utility tools such as APT) and to find used cubes when the |
10517
fa9a0c80556d
[schema] drop old backward compat code
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
10491
diff
changeset
|
24 |
database for the instance is created. |
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
25 |
|
6928
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
26 |
On a Unix system, the available cubes are usually stored in the |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
27 |
directory :file:`/usr/share/cubicweb/cubes`. If you are using the |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
28 |
cubicweb mercurial repository (:ref:`SourceInstallation`), the cubes |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
29 |
are searched in the directory |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
30 |
:file:`/path/to/cubicweb_toplevel/cubes`. In this configuration |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
31 |
cubicweb itself ought to be located at |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
32 |
:file:`/path/to/cubicweb_toplevel/cubicweb`. |
62b8ef1e859a
[doc/book] simplify & fix the overview chapter
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
5608
diff
changeset
|
33 |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
34 |
.. note:: |
4437
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
35 |
|
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
36 |
Please note that if you do not wish to use default directory for your cubes |
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
37 |
library, you should set the :envvar:`CW_CUBES_PATH` environment variable to |
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
38 |
add extra directories where cubes will be search, and you'll then have to use |
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
39 |
the option `--directory` to specify where you would like to place the source |
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
40 |
code of your cube: |
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
41 |
|
21f2e01fdd6a
update exemples using the 3.6 api and add/fix some sections (schema, vreg, talk about CW_MODE in concepts...). So much to do :'(
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2280
diff
changeset
|
42 |
``cubicweb-ctl newcube --directory=/path/to/cubes/library mycube`` |