rodolf
======
RDF data production monitoring (RODOLF)
Installation
------------
Open the project in a terminal and run::
pip install -e .
This will install the cube in your active virtual environment
as ``cubicweb-rodolf``.
The following sections indicate additional steps when you
install this cube as a dependency or as an instance.
As a dependency
~~~~~~~~~~~~~~~
If you plan to use this cube as a dependency for your own cube,
add it to your ``__pkginfo__.py`` as follows::
__depends__ = {
# ... Your previous dependencies
"cubicweb-rodolf": None,
}
If the target cube is already used as an instance, you need to migrate it
with the help of its python shell (replace ``YOUR_INSTANCE_NAME`` by your instance name)::
cubicweb-ctl shell YOUR_INSTANCE_NAME
In the python prompt, enter the following command::
add_cube("rodolf")
Press ``Ctrl-D`` then restart your instance.
The cube should now be available in your instance.
As an instance
~~~~~~~~~~~~~~
If you plan to use this cube directly as an instance, create and start
your instance with the following commands (replace ``rodolf-instance``
by the name of your choice)::
cubicweb-ctl create rodolf rodolf-instance
cubicweb-ctl start -D rodolf-instance
use docker compose for local developpements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The docker-compose.yaml contains the following containers :
- rodolf-backend: the cubicweb instance
- rodolf-frontend: the nextjs front
- virtuoso: the rdf repository and sparql endpoint
- minio: object storage server
- postgresql: sql database server
- redis: key value database for session and rq tasks
When starting for the first time you must run following commands:
.. code-block::
# install node modules in your volumes
docker compose run --rm --entrypoint npm rodolf-frontend ci
# set the localinstall egg in your volume
docker compose run --rm --entrypoint pip rodolf-backend install -e /src
# create the instance
docker compose run --entrypoint docker-cubicweb-helper rodolf-backend create-instance
# init the db
docker compose run --rm --entrypoint cubicweb-ctl rodolf-backend db-init instance -a
Then to start the services do:
.. code-block::
docker compose up --build -d
Then you need to create a new bucket on minio. To do so, open
http://localhost:9001/, log in with the credentials defined in the
docker-compose, and create a bucket named according to the value of
the variable `RODOLF_S3_BUCKET`.
Restart all services and point your browser to::
# virtuoso
http://localhost:8890/
# rodolf frontend
http://localhost:3000/
# rodolf backend
http://localhost:8080/
# minio
http://localhost:9001/
/!\ for a local use, make sure to configure projects with
`http://virtuoso:8890` as virtuoso URL, so that the backend can
communicate with it.
Learn More
----------
Visit the `official documentation <https://cubicweb.readthedocs.io/en/4.5.2>`_
to learn more about CubicWeb.
Raw data
{
"_id": null,
"home_page": "https://forge.extranet.logilab.fr/cubicweb/cubes/rodolf",
"name": "cubicweb-rodolf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "LOGILAB S.A. (Paris, FRANCE)",
"author_email": "contact@logilab.fr",
"download_url": "https://files.pythonhosted.org/packages/df/01/b1fc5c8f608e30859979cea91df65e84e00ac949ff32aaf5b819b2f21548/cubicweb_rodolf-0.12.0.tar.gz",
"platform": null,
"description": "rodolf\n======\n\nRDF data production monitoring (RODOLF)\n\nInstallation\n------------\n\nOpen the project in a terminal and run::\n\n pip install -e .\n\nThis will install the cube in your active virtual environment\nas ``cubicweb-rodolf``.\n\nThe following sections indicate additional steps when you\ninstall this cube as a dependency or as an instance.\n\nAs a dependency\n~~~~~~~~~~~~~~~\n\nIf you plan to use this cube as a dependency for your own cube,\nadd it to your ``__pkginfo__.py`` as follows::\n\n __depends__ = {\n # ... Your previous dependencies\n \"cubicweb-rodolf\": None,\n }\n\nIf the target cube is already used as an instance, you need to migrate it\nwith the help of its python shell (replace ``YOUR_INSTANCE_NAME`` by your instance name)::\n\n cubicweb-ctl shell YOUR_INSTANCE_NAME\n\nIn the python prompt, enter the following command::\n\n add_cube(\"rodolf\")\n\nPress ``Ctrl-D`` then restart your instance.\nThe cube should now be available in your instance.\n\nAs an instance\n~~~~~~~~~~~~~~\n\nIf you plan to use this cube directly as an instance, create and start\nyour instance with the following commands (replace ``rodolf-instance``\nby the name of your choice)::\n\n cubicweb-ctl create rodolf rodolf-instance\n cubicweb-ctl start -D rodolf-instance\n\nuse docker compose for local developpements\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe docker-compose.yaml contains the following containers :\n- rodolf-backend: the cubicweb instance\n- rodolf-frontend: the nextjs front\n- virtuoso: the rdf repository and sparql endpoint\n- minio: object storage server\n- postgresql: sql database server\n- redis: key value database for session and rq tasks\n\nWhen starting for the first time you must run following commands:\n\n.. code-block::\n\n # install node modules in your volumes\n docker compose run --rm --entrypoint npm rodolf-frontend ci\n\n # set the localinstall egg in your volume\n docker compose run --rm --entrypoint pip rodolf-backend install -e /src\n\n # create the instance\n docker compose run --entrypoint docker-cubicweb-helper rodolf-backend create-instance\n\n # init the db\n docker compose run --rm --entrypoint cubicweb-ctl rodolf-backend db-init instance -a\n\nThen to start the services do:\n\n.. code-block::\n\n docker compose up --build -d\n\nThen you need to create a new bucket on minio. To do so, open\nhttp://localhost:9001/, log in with the credentials defined in the\ndocker-compose, and create a bucket named according to the value of\nthe variable `RODOLF_S3_BUCKET`.\n\nRestart all services and point your browser to::\n\n # virtuoso\n http://localhost:8890/\n\n # rodolf frontend\n http://localhost:3000/\n\n # rodolf backend\n http://localhost:8080/\n\n # minio\n http://localhost:9001/\n\n\n\n/!\\ for a local use, make sure to configure projects with\n`http://virtuoso:8890` as virtuoso URL, so that the backend can\ncommunicate with it.\n\nLearn More\n----------\n\nVisit the `official documentation <https://cubicweb.readthedocs.io/en/4.5.2>`_\nto learn more about CubicWeb.\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "RDF data production monitoring (RODOLF)",
"version": "0.12.0",
"project_urls": {
"Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/rodolf"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "154cad2b76a8d89c8f19112d5f1b531349c017d16ac9f394774241fd27256a45",
"md5": "adc38dfe1f6261b2ab096feb5d1daa82",
"sha256": "84ec74043c44904e4e3009db87a3220dd3acb4ecc6aa05f34af8743906688f4f"
},
"downloads": -1,
"filename": "cubicweb_rodolf-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adc38dfe1f6261b2ab096feb5d1daa82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 39345,
"upload_time": "2024-09-19T08:39:42",
"upload_time_iso_8601": "2024-09-19T08:39:42.935095Z",
"url": "https://files.pythonhosted.org/packages/15/4c/ad2b76a8d89c8f19112d5f1b531349c017d16ac9f394774241fd27256a45/cubicweb_rodolf-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df01b1fc5c8f608e30859979cea91df65e84e00ac949ff32aaf5b819b2f21548",
"md5": "8b3faf0a262ee8454bbecd0310155684",
"sha256": "56091d0a20ac03eae5eaa3a5b803293224a8ea8918e0df0288b49b7090802050"
},
"downloads": -1,
"filename": "cubicweb_rodolf-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "8b3faf0a262ee8454bbecd0310155684",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 294863,
"upload_time": "2024-09-19T08:39:45",
"upload_time_iso_8601": "2024-09-19T08:39:45.376456Z",
"url": "https://files.pythonhosted.org/packages/df/01/b1fc5c8f608e30859979cea91df65e84e00ac949ff32aaf5b819b2f21548/cubicweb_rodolf-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 08:39:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cubicweb-rodolf"
}
JSON