nxsconfigserver-db


Namenxsconfigserver-db JSON
Version 1.10.5 PyPI version JSON
download
home_pagehttps://github.com/jkotan/nexdatas/nxsconfigserver-db
SummaryConfiguration Server DataBase
upload_time2024-04-09 07:10:44
maintainerNone
docs_urlNone
authorJan Kotanski
requires_pythonNone
licenseGNU GENERAL PUBLIC LICENSE v3
keywords configuration mysql writer tango server nexus data
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===============================================================
Welcome to NeXuS Configuration Server Database's documentation!
===============================================================

|github workflow|
|docs|
|Pypi Version|
|Python Versions|

.. |github workflow| image:: https://github.com/nexdatas/nxsconfigserver-db/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/nexdatas/nxsconfigserver-db/actions
   :alt:

.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
   :target: https://nexdatas.github.io/nxsconfigserver-db/index.html
   :alt:

.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxsconfigserver-db.svg
                  :target: https://pypi.python.org/pypi/nxsconfigserver-db
                  :alt:

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxsconfigserver-db.svg
                     :target: https://pypi.python.org/pypi/nxsconfigserver-db/
                     :alt:


Authors: Jan Kotanski, Eugen Wintersberger, Halil Pasic

The package contains SQL files to create the MySQL database for Configuration Server.

NeXuS Configuration Server is a Tango Server with its implementation based
on a MySQL database. It allows to store XML configuration datasources
and components. It also gives possibility to select mandatory components
and perform the process of component merging.

| Source code: https://github.com/nexdatas/nxsconfigserver-db
| Web page: https://nexdatas.github.io/nxsconfigserver-db

------------
Installation
------------

Install the dependencies:

|    MySQLdb, PyTango, sphinx

From sources
^^^^^^^^^^^^

Download the latest version of NeXuS Configuration Server from

|     https://github.com/nexdatas/nxsconfigserver
|     https://github.com/nexdatas/nxsconfigserver-db

Extract the sources and run for both packages

.. code-block:: console

	  $ python setup.py install

To set database execute

.. code-block:: console

	  $ mysql < conf/mysql_create.sql

with proper privileges.

Debian packages
^^^^^^^^^^^^^^^

Debian Bookworm, Bullseye, Buster as well as Lunar, Jammy, Focal packages can be found in the HDRI repository.

To install the debian packages, add the PGP repository key

.. code-block:: console

	  $ sudo su
	  $ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -

and then download the corresponding source list

.. code-block:: console

	  $ cd /etc/apt/sources.list.d
	  $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list

Finally,

.. code-block:: console

	  $ apt-get update
	  $ apt-get install python-nxsconfigserver nxsconfigserver-db

To instal other NexDaTaS packages

.. code-block:: console

	  $ apt-get install python-nxswriter nxsconfigtool nxstools

and

.. code-block:: console

	  $ apt-get install python-nxsrecselector nxselector python-sardana-nxsrecorder

for Component Selector and Sardana related packages.

From pip
^^^^^^^^

To install it from pip you can

.. code-block:: console

   $ python3 -m venv myvenv
   $ . myvenv/bin/activate

   $ pip install nxsconfigserver-db

Moreover it is also good to install **mysql** to be able to execute

.. code-block:: console

	  $ mysql < conf/mysql_create.sql

where **mysql_create.sql** is installed in  **myvenv/share/nxsconfigserver**

Setting NeXus Configuration Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To set up  NeXus Configuration Server with the default configuration run

.. code-block:: console

          $ nxsetup -x NXSConfigServer

The *nxsetup* command comes from the **python-nxstools** package.
It starts the NeXus Configuration Server and tries to find a proper value
of the JSONSettings attribute.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jkotan/nexdatas/nxsconfigserver-db",
    "name": "nxsconfigserver-db",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "configuration MySQL writer Tango server nexus data",
    "author": "Jan Kotanski",
    "author_email": "jankotan@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/24/af/41ef0a8879b461d991a0990ac975021642417e3f69fe4ccbd27975a3f0b8/nxsconfigserver-db-1.10.5.tar.gz",
    "platform": null,
    "description": "===============================================================\nWelcome to NeXuS Configuration Server Database's documentation!\n===============================================================\n\n|github workflow|\n|docs|\n|Pypi Version|\n|Python Versions|\n\n.. |github workflow| image:: https://github.com/nexdatas/nxsconfigserver-db/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/nexdatas/nxsconfigserver-db/actions\n   :alt:\n\n.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg\n   :target: https://nexdatas.github.io/nxsconfigserver-db/index.html\n   :alt:\n\n.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxsconfigserver-db.svg\n                  :target: https://pypi.python.org/pypi/nxsconfigserver-db\n                  :alt:\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxsconfigserver-db.svg\n                     :target: https://pypi.python.org/pypi/nxsconfigserver-db/\n                     :alt:\n\n\nAuthors: Jan Kotanski, Eugen Wintersberger, Halil Pasic\n\nThe package contains SQL files to create the MySQL database for Configuration Server.\n\nNeXuS Configuration Server is a Tango Server with its implementation based\non a MySQL database. It allows to store XML configuration datasources\nand components. It also gives possibility to select mandatory components\nand perform the process of component merging.\n\n| Source code: https://github.com/nexdatas/nxsconfigserver-db\n| Web page: https://nexdatas.github.io/nxsconfigserver-db\n\n------------\nInstallation\n------------\n\nInstall the dependencies:\n\n|    MySQLdb, PyTango, sphinx\n\nFrom sources\n^^^^^^^^^^^^\n\nDownload the latest version of NeXuS Configuration Server from\n\n|     https://github.com/nexdatas/nxsconfigserver\n|     https://github.com/nexdatas/nxsconfigserver-db\n\nExtract the sources and run for both packages\n\n.. code-block:: console\n\n\t  $ python setup.py install\n\nTo set database execute\n\n.. code-block:: console\n\n\t  $ mysql < conf/mysql_create.sql\n\nwith proper privileges.\n\nDebian packages\n^^^^^^^^^^^^^^^\n\nDebian Bookworm, Bullseye, Buster as well as Lunar, Jammy, Focal packages can be found in the HDRI repository.\n\nTo install the debian packages, add the PGP repository key\n\n.. code-block:: console\n\n\t  $ sudo su\n\t  $ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -\n\nand then download the corresponding source list\n\n.. code-block:: console\n\n\t  $ cd /etc/apt/sources.list.d\n\t  $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list\n\nFinally,\n\n.. code-block:: console\n\n\t  $ apt-get update\n\t  $ apt-get install python-nxsconfigserver nxsconfigserver-db\n\nTo instal other NexDaTaS packages\n\n.. code-block:: console\n\n\t  $ apt-get install python-nxswriter nxsconfigtool nxstools\n\nand\n\n.. code-block:: console\n\n\t  $ apt-get install python-nxsrecselector nxselector python-sardana-nxsrecorder\n\nfor Component Selector and Sardana related packages.\n\nFrom pip\n^^^^^^^^\n\nTo install it from pip you can\n\n.. code-block:: console\n\n   $ python3 -m venv myvenv\n   $ . myvenv/bin/activate\n\n   $ pip install nxsconfigserver-db\n\nMoreover it is also good to install **mysql** to be able to execute\n\n.. code-block:: console\n\n\t  $ mysql < conf/mysql_create.sql\n\nwhere **mysql_create.sql** is installed in  **myvenv/share/nxsconfigserver**\n\nSetting NeXus Configuration Server\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo set up  NeXus Configuration Server with the default configuration run\n\n.. code-block:: console\n\n          $ nxsetup -x NXSConfigServer\n\nThe *nxsetup* command comes from the **python-nxstools** package.\nIt starts the NeXus Configuration Server and tries to find a proper value\nof the JSONSettings attribute.",
    "bugtrack_url": null,
    "license": "GNU GENERAL PUBLIC LICENSE v3",
    "summary": "Configuration Server  DataBase",
    "version": "1.10.5",
    "project_urls": {
        "Homepage": "https://github.com/jkotan/nexdatas/nxsconfigserver-db"
    },
    "split_keywords": [
        "configuration",
        "mysql",
        "writer",
        "tango",
        "server",
        "nexus",
        "data"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "24af41ef0a8879b461d991a0990ac975021642417e3f69fe4ccbd27975a3f0b8",
                "md5": "f4afcfbc4624e1ec1bc1a6a5dc338eba",
                "sha256": "f3d0544408fb54340455a25d53c08c4cdc24c6c48789e5aca273fbbf47f7789f"
            },
            "downloads": -1,
            "filename": "nxsconfigserver-db-1.10.5.tar.gz",
            "has_sig": false,
            "md5_digest": "f4afcfbc4624e1ec1bc1a6a5dc338eba",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 25994,
            "upload_time": "2024-04-09T07:10:44",
            "upload_time_iso_8601": "2024-04-09T07:10:44.537785Z",
            "url": "https://files.pythonhosted.org/packages/24/af/41ef0a8879b461d991a0990ac975021642417e3f69fe4ccbd27975a3f0b8/nxsconfigserver-db-1.10.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-09 07:10:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jkotan",
    "github_project": "nexdatas",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nxsconfigserver-db"
}
        
Elapsed time: 0.46870s