opensipscli 0.3.5__tar.gz → 0.4.1__tar.gz

opensipscli-0.4.1/.github/workflows/docker-push-image.yml

@@ -0,0 +1,38 @@
+name: Push OpenSIPS CLI Images in Docker Hub
+
+on:
+  push:
+  repository_dispatch:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v4
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v4
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_TOKEN }}
+
+    - name: Log in to GitHub Container Registry
+      uses: docker/login-action@v4
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and push Docker image
+      uses: docker/build-push-action@v7
+      with:
+        context: ./docker/
+        push: true
+        tags: |
+          opensips/opensips-cli:latest
+          ghcr.io/opensips/opensips-cli:latest

{opensipscli-0.3.5 → opensipscli-0.4.1}/.github/workflows/docker-readme.yml

@@ -12,11 +12,11 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
 
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v4
+      uses: peter-evans/dockerhub-description@v5
       with:
         username: ${{ secrets.DOCKER_USERNAME }}
         password: ${{ secrets.DOCKER_TOKEN }}

{opensipscli-0.3.5 → opensipscli-0.4.1}/.github/workflows/pypi.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: "3.x"
     - name: Install pypa/build
@@ -23,7 +23,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: python-package-distributions
         path: dist/
@@ -43,7 +43,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/
@@ -64,7 +64,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: python-package-distributions
         path: dist/

{opensipscli-0.3.5 → opensipscli-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: opensipscli
-Version: 0.3.5
+Version: 0.4.1
 Summary: OpenSIPS Command Line Interface
 Project-URL: Homepage, https://github.com/OpenSIPS/opensips-cli
 Project-URL: Source, https://github.com/OpenSIPS/opensips-cli
@@ -14,10 +14,9 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
-Requires-Dist: mysqlclient<1.4.0rc1
 Requires-Dist: opensips
-Requires-Dist: sqlalchemy-utils
-Requires-Dist: sqlalchemy<2,>=1.3.3
+Requires-Dist: pymysql
+Requires-Dist: sqlalchemy>=1.3.2
 Description-Content-Type: text/markdown
 
 # OpenSIPS CLI (Command Line Interface)
@@ -92,7 +91,7 @@ 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)
 ...
 ```
@@ -100,7 +99,7 @@ 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")
 ...
 ```

{opensipscli-0.3.5 → opensipscli-0.4.1}/README.md

@@ -70,7 +70,7 @@ 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)
 ...
 ```
@@ -78,7 +78,7 @@ 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")
 ...
 ```

{opensipscli-0.3.5 → opensipscli-0.4.1}/bin/opensips-cli

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

{opensipscli-0.3.5 → opensipscli-0.4.1}/docker/Dockerfile

@@ -8,7 +8,7 @@ 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 && \
@@ -16,7 +16,7 @@ RUN git clone https://github.com/OpenSIPS/opensips-cli.git /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
 

{opensipscli-0.3.5 → opensipscli-0.4.1}/docs/INSTALLATION.md

@@ -17,8 +17,8 @@ to your system using the instructions provided, then install the
 
 Supported Operating Systems (at the time of writing):
 
-* Debian 8-10
-* Ubuntu 14.04, 16.04, 18.04, 19.04
+* Debian 10-12
+* Ubuntu 18.04, 20.04, 22.04, 24.04
 
 ### RPM packages (.rpm)
 
@@ -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

{opensipscli-0.3.5 → opensipscli-0.4.1}/docs/modules/database.md

@@ -14,7 +14,10 @@ which database to delete.
 parameter the name of the module, as specified in the OpenSIPS scripts
 hierarchy.
 * `migrate` - copy and convert an OpenSIPS database into its next OpenSIPS
-release equivalent
+  release equivalent
+* `pi` - creates a `pi_http` framework from the framework shipped with
+  OpenSIPS, using the configured database URL and modules. An optional output
+  path may be provided.
 
 ## Configuration
 
@@ -90,6 +93,17 @@ opensips-cli -x database add rtpproxy
 ```
 The command above will create the `rtpproxy_sockets` table.
 
+To create a provisioning framework for the configured modules, run:
+
+```
+opensips-cli -x database pi /etc/opensips/pi_framework.xml
+```
+
+The command reuses the framework shipped in the OpenSIPS `pi_http` scripts,
+including its module-specific columns, validations, and commands. When
+`database_modules` is not `ALL`, entries for other modules are removed from
+the generated file.
+
 A drop command will prompt the user whether they really want to drop the
 database or not:
 
@@ -132,8 +146,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
 

{opensipscli-0.3.5 → opensipscli-0.4.1}/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-0.3.5 → opensipscli-0.4.1}/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-0.3.5 → opensipscli-0.4.1}/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-0.3.5 → opensipscli-0.4.1}/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).
@@ -195,6 +195,7 @@ class OpenSIPSCLI(cmd.Cmd, object):
         """
         preload a history file
         """
+        self.configure_completion_delims()
         history_file = cfg.get('history_file')
         logger.debug("using history file {}".format(history_file))
         try:
@@ -210,6 +211,14 @@ class OpenSIPSCLI(cmd.Cmd, object):
         if not self.registered_atexit:
             atexit.register(self.history_write)
 
+    def configure_completion_delims(self):
+        """
+        keep ':' inside tokens for command completion (e.g. "mi evi:")
+        """
+        delims = readline.get_completer_delims()
+        if ':' in delims:
+            readline.set_completer_delims(delims.replace(':', ''))
+
     def postcmd(self, stop, line):
         """
         post command after switching instance

{opensipscli-0.3.5 → opensipscli-0.4.1}/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).

{opensipscli-0.3.5 → opensipscli-0.4.1}/opensipscli/config.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).