Metadata-Version: 2.4
Name: icepapcms
Version: 4.1.0
Summary: Icepap Configuration Management System and Test Tool
Author-email: "Guifre Cuni et al." <controls@cells.es>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://gitlab.com/icepap-organization/IcepapCMS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: storm>=0.23
Requires-Dist: IPy>=0.62
Requires-Dist: PyQt6
Requires-Dist: icepap>=3.7.0
Requires-Dist: configobj!=5.0.7
Requires-Dist: ldap3
Requires-Dist: PyYAML
Dynamic: license-file

# IcepapCMS

![Pypi version][pypi]

IcepapCMS is a graphical configuration and test tool for the Icepap motor
controller, base on icepap library.

It allows to configure the electrical parameters, I/O interfaces, encoders,
movement parameters, homing procedures.

All changes are saved on a data base which allows to do easy rollbacks,
identified changes and conflicts between the hardware configuration and the
data base configuration.

The program includes one graphical console to communicate with raw commands.

## Installation

### Pypi

From within your favourite python environment:

```console
pip install PyQt6 icepapcms
```

To use MySQL Databases you should
install [mysqlclient](https://pypi.org/project/mysqlclient/)

To use PostgreSQL Databeses you should
install [psycopg2](https://pypi.org/project/psycopg2/)

## Contribute

You can find how to contribute to this project on CONTRIBUTING.md file.

# Ldap configuration:

The LDAP configuration is located on the icepapcms configuration file:

`<user home>/.icepapcms/icepapcms.conf`

The section "ldap" should have the next configuration:

```
[ldap]
    use = True
    not_allowed = root, operator, xxxxx
    servers = 'ldap://ldap01.test.com','ldap://ldap02.test.es'
    user_template = 'uid={},ou=Users,dc=Company,dc=XX'

```

# All networks configuration

The all networks flag is allowed: icepapcms --all-networks

To avoid launching icepapcms with the flag all the time, it is possible to
configure it on the icepapcms configuration file:

`<user home>/.icepapcms/icepapcms.conf`

The section "all_networks" should have the next configuration:

```
[all_networks]
use = True
```

[pypi]: https://img.shields.io/pypi/pyversions/icepap.svg
