Merge pull request #158 from dariusstefan/master

packaging: switch to PyMySQL and support SQLAlchemy 1.4/2.0

Author: razvancrainea

README.md

@@ -70,15 +70,15 @@ The OpenSIPSCLI object can receive a set of arguments/modifiers through the
 ```
 from opensipscli import args
 ...
-args = OpenSIPSCLIArgs(debug=True)
+args = args.OpenSIPSCLIArgs(debug=True)
 opensipscli = cli.OpenSIPSCLI(args)
 ...
 ```
 
 Custom settings can be provided through the arguments, i.e.:
 ```
 # run commands over http
-args = OpenSIPSCLIArgs(communication_type = "http",
+args = args.OpenSIPSCLIArgs(communication_type = "http",
                        url="http://127.0.0.1:8080/mi")
 ...
 ```

bin/opensips-cli

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 from opensipscli import main
 

docker/Dockerfile

@@ -8,15 +8,15 @@ ENV DEBIAN_FRONTEND noninteractive
 
 #install basic components
 RUN apt-get -y update -qq && \
-    apt-get -y install git default-libmysqlclient-dev gcc
+    apt-get -y install git
 
 #add keyserver, repository
 RUN git clone https://github.com/OpenSIPS/opensips-cli.git /usr/src/opensips-cli && \
     cd /usr/src/opensips-cli && \
     python3 -m pip install . && \
     cd / && rm -rf /usr/src/opensips-cli
 
-RUN apt-get purge -y git gcc && \
+RUN apt-get purge -y git && \
     apt-get autoremove -y && \
     apt-get clean
 

docs/INSTALLATION.md

@@ -56,27 +56,26 @@ will vary on every supported operating system.
 
 ```
 # required OS packages
-sudo apt install python3 python3-pip python3-dev gcc default-libmysqlclient-dev \
-                 python3-mysqldb python3-sqlalchemy python3-sqlalchemy-utils \
+sudo apt install python3 python3-pip python3-pymysql python3-sqlalchemy \
                  python3-openssl
 
 # alternatively, you can build the requirements from source
-sudo pip3 install mysqlclient sqlalchemy sqlalchemy-utils pyOpenSSL
+sudo pip3 install PyMySQL sqlalchemy pyOpenSSL
 ```
 
 #### Red Hat / CentOS
 
 ```
 # required CentOS 7 packages
-sudo yum install python36 python36-pip python36-devel gcc mysql-devel \
-                 python36-mysql python36-sqlalchemy python36-pyOpenSSL
+sudo yum install python36 python36-pip python36-PyMySQL \
+                 python36-sqlalchemy python36-pyOpenSSL
 
 # required CentOS 8 packages
-sudo yum install python3 python3-pip python3-devel gcc mysql-devel \
-                 python3-mysqlclient python3-sqlalchemy python3-pyOpenSSL
+sudo yum install python3 python3-pip python3-PyMySQL \
+                 python3-sqlalchemy python3-pyOpenSSL
 
 # alternatively, you can build the requirements from source
-sudo pip3 install mysqlclient sqlalchemy sqlalchemy-utils pyOpenSSL
+sudo pip3 install PyMySQL sqlalchemy pyOpenSSL
 ```
 
 ### Download, Build & Install

docs/modules/database.md

@@ -132,8 +132,10 @@ opensips-cli -o database_schema_path=~/src/opensips-3.1/scripts \
 
 ## Dependencies
 
-* [sqlalchemy and sqlalchemy_utils](https://www.sqlalchemy.org/) - used to
-abstract the SQL database regardless of the backend used
+* [sqlalchemy](https://www.sqlalchemy.org/) - used to abstract the SQL
+database regardless of the backend used
+* [PyMySQL](https://github.com/PyMySQL/PyMySQL) - pure-Python MySQL/MariaDB
+driver used by SQLAlchemy when connecting to MySQL backends
 
 ## Limitations
 

docs/modules/user.md

@@ -53,8 +53,8 @@ opensips-cli -x user delete username@domain.com
 
 ## Dependencies
 
-* [sqlalchemy and sqlalchemy_utils](https://www.sqlalchemy.org/) - used to
-abstract the database manipulation, regardless of the backend used
+* [sqlalchemy](https://www.sqlalchemy.org/) - used to abstract the database
+manipulation, regardless of the backend used
 
 ## Limitations
 

opensipscli/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

opensipscli/args.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

opensipscli/cli.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

opensipscli/comm.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).