opensipscli 0.3.1__py3-none-any.whl

opensipscli-0.3.1.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.1
+Name: opensipscli
+Version: 0.3.1
+Summary: OpenSIPS Command Line Interface
+Home-page: https://github.com/OpenSIPS/opensips-cli
+Download-URL: https://github.com/OpenSIPS/opensips-cli/archive/master.zip
+Author: OpenSIPS Project
+Author-email: project@opensips.org
+Maintainer: Razvan Crainea
+Maintainer-email: razvan@opensips.org
+Project-URL: Source Code, https://github.com/OpenSIPS/opensips-cli
+Project-URL: Issues Tracker, https://github.com/OpenSIPS/opensips-cli/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opensips
+Requires-Dist: mysqlclient<1.4.0rc1
+Requires-Dist: sqlalchemy<2,>=1.3.3
+Requires-Dist: sqlalchemy-utils
+
+# OpenSIPS CLI (Command Line Interface)
+
+OpenSIPS CLI is an interactive command line tool that can be used to control
+and monitor **OpenSIPS SIP servers**. It uses the Management Interface
+exported by OpenSIPS over JSON-RPC to gather raw information from OpenSIPS and
+display it in a nicer, more structured manner to the user.
+
+The tool is very flexible and has a modular design, consisting of multiple
+modules that implement different features. New modules can be easily added by
+creating a new module that implements the [OpenSIPS CLI
+Module](opensipscli/module.py) Interface.
+
+OpenSIPS CLI is an interactive console that features auto-completion and
+reverse/forward command history search, but can also be used to execute
+one-liners for automation purposes.
+
+OpenSIPS CLI can communicate with an OpenSIPS server using different transport
+methods, such as fifo or http.
+
+# Compatibility
+
+This tool uses the new JSON-RPC interface added in OpenSIPS 3.0, therefore
+it can only be used with OpenSIPS versions higher than or equal to 3.0.  For older
+versions of OpenSIPS, use the classic `opensipsctl` tool from the `opensips` project.
+
+## Usage
+
+### Tool
+
+Simply run `opensips-cli` tool directly in your cli.
+By default the tool will start in interactive mode.
+
+OpenSIPS CLI accepts the following arguments:
+* `-h|--help` - used to display information about running `opensips-cli`
+* `-v|--version` - displays the version of the running tool
+* `-d|--debug` - starts the `opensips-cli` tool with debugging enabled
+* `-f|--config` - specifies a configuration file (see [Configuration
+Section](#configuration) for more information)
+* `-i|--instance INSTANCE` - changes the configuration instance (see [Instance
+Module](docs/modules/instance.md) Documentation for more information)
+* `-o|--option KEY=VALUE` - sets/overwrites the `KEY` configuration parameter
+with the specified `VALUE`. Works for both core and modules parameters. Can be
+used multiple times, for different options
+* `-x|--execute` - executes the command specified and exits
+
+In order to run `opensips-cli` without installing it, you have to export the
+`PYTHONPATH` variable to the root of the `opensips-cli` and `python-opensips`
+packages. If you installed the two packages under `/usr/local/src`, simply do:
+
+```
+export PYTHONPATH=/usr/local/src/opensips-cli:/usr/local/src/python-opensips
+/usr/local/src/opensips-cli/bin/opensips-cli
+```
+
+### Python Module
+
+The module can be used as a python module as well. A simple snippet of running
+an MI command using the tool is:
+
+```
+from opensipscli import cli
+
+opensipscli = cli.OpenSIPSCLI()
+print(opensipscli.mi('ps'))
+```
+
+The OpenSIPSCLI object can receive a set of arguments/modifiers through the
+`OpenSIPSCLIArgs` class, i.e.:
+
+```
+from opensipscli import args
+...
+args = OpenSIPSCLIArgs(debug=True)
+opensipscli = cli.OpenSIPSCLI(args)
+...
+```
+
+Custom settings can be provided thourgh the arguments, i.e.:
+```
+# run commands over http
+args = OpenSIPSCLIArgs(communcation_type = "http",
+                       url="http://127.0.0.1:8080/mi")
+...
+```
+
+### Docker Image
+
+The OpenSIPS CLI tool can be run in a Docker container. The image is available
+on Docker Hub at [opensips/opensips-cli](https://hub.docker.com/r/opensips/opensips-cli).
+For more information on how to run the tool in a Docker container, please refer to the
+[OpenSIPS CLI Docker Image](docker/docker.md) documentation.
+
+## Configuration
+
+OpenSIPS CLI accepts a configuration file, formatted as an `ini` or `cfg`
+file, that can store certain parameters that influence the behavior of the
+OpenSIPS CLI tool. You can find [here](etc/default.cfg) an example of a
+configuration file that behaves exactly as the default parameters. The set of
+default values used, when no configuration file is specified, can be found
+[here](opensipscli/defaults.py).
+
+The configuration file can have multiple sections/instances, managed by the
+[Instance](docs/modules/instance.md) module. One can choose different
+instances from the configuration file by specifying the `-i INSTANCE` argument
+when starting the cli tool.
+
+If no configuration file is specified by the `-f|--config` argument, OpenSIPS
+CLI searches for one in the following locations:
+
+* `~/.opensips-cli.cfg` (highest precedence)
+* `/etc/opensips-cli.cfg`
+* `/etc/opensips/opensips-cli.cfg` (lowest precedence)
+
+If no file is found, it starts with the default configuration.
+
+The OpenSIPS CLI core can use the following parameters:
+
+* `prompt_name`: The name of the OpenSIPS CLI prompt (Default: `opensips-cli`)
+* `prompt_intro`: Introduction message when entering the OpenSIPS CLI
+* `prompt_emptyline_repeat_cmd`: Repeat the last command on an emptyline (Default: `False`)
+* `history_file`: The path of the history file (Default: `~/.opensips-cli.history`)
+* `history_file_size`: The backlog size of the history file (Default: `1000`)
+* `log_level`: The level of the console logging (Default: `WARNING`)
+* `communication_type`: Communication transport used by OpenSIPS CLI (Default: `fifo`)
+* `fifo_file`: The OpenSIPS FIFO file to which the CLI will write commands
+(Default: `/var/run/opensips/opensips_fifo`)
+* `fifo_file_fallback`: A fallback FIFO file that is being used when the `fifo_file`
+is not found - this has been introduces for backwards compatibility when the default
+`fifo_file` has been changed from `/tmp/opensips_fifo` (Default: `/tmp/opensips_fifo`)
+* `fifo_reply_dir`: The default directory where `opensips-cli` will create the
+fifo used for the reply from OpenSIPS (Default: `/tmp`)
+* `url`: The default URL used when `http` `communication_type` is used
+(Default: `http://127.0.0.1:8888/mi`).
+* `datagram_ip`: The default IP used when `datagram` `communication_type` is used (Default: `127.0.0.1`)
+* `datagram_port`: The default port used when `datagram` `communication_type` is used (Default: `8080`)
+
+Each module can use each of the parameters above, but can also declare their
+own. You can find in each module's documentation page the parameters that they
+are using.
+
+Configuration parameters can be overwritten using the `-o/--option` arguments,
+as described in the [Usage](#tool) section.
+
+It is also possible to set a parameters dynamically, using the `set` command.
+This configuration is only available during the current interactive session,
+and also gets cleaned up when an instance is switched.
+
+## Modules
+
+The OpenSIPS CLI tool consists of the following modules:
+* [Management Interface](docs/modules/mi.md) - run MI commands
+* [Database](docs/modules/database.md) - commands to create, modify, drop, or
+migrate an OpenSIPS database
+* [Diagnose](docs/modules/diagnose.md) - instantly diagnose OpenSIPS instances
+* [Instance](docs/modules/instance.md) - used to switch through different
+instances/configuration within the config file
+* [User](docs/modules/user.md) - utility used to add and remove OpenSIPS users
+* [Trace](docs/modules/trace.md) - trace calls information from users
+* [Trap](docs/modules/trap.md) - use `gdb` to take snapshots of OpenSIPS workers
+* [TLS](docs/modules/tls.md) - utility to generate certificates for TLS
+
+## Communication
+
+OpenSIPS CLI can communicate with an OpenSIPS instance through MI using
+different transports. Supported transports at the moment are:
+* `FIFO` - communicate over the `mi_fifo` module
+* `HTTP` - use JSONRPC over HTTP through the `mi_http` module
+* `DATAGRAM` - communicate over UDP using the `mi_datagram` module
+
+## Installation
+
+Please follow the details provided in the
+<a href="docs/INSTALLATION.md">Installation</a> section, for a complete guide
+on how to install `opensips-cli` as a replacement for the deprecated
+`opensipsctl` shell script.
+
+## Contribute
+
+Feel free to contribute to this project with any module, or functionality you
+find useful by opening a pull request.
+
+## History
+
+This project was started by **Dorin Geman**
+([dorin98](https://github.com/dorin98)) as part of the [ROSEdu
+2018](http://soc.rosedu.org/2018/) program. It has later been adapted to the
+new OpenSIPS 3.0 MI interface and became the main external tool for managing
+OpenSIPS.
+
+## License
+
+<!-- License source -->
+[License-GPLv3]: https://www.gnu.org/licenses/gpl-3.0.en.html "GNU GPLv3"
+[Logo-CC_BY]: https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Common Logo"
+[License-CC_BY]: https://creativecommons.org/licenses/by/4.0/legalcode "Creative Common License"
+
+The `opensips-cli` source code is licensed under the [GNU General Public License v3.0][License-GPLv3]
+
+All documentation files (i.e. `.md` extension) are licensed under the [Creative Common License 4.0][License-CC_BY]
+
+![Creative Common Logo][Logo-CC_BY]
+
+© 2018 - 2020  OpenSIPS Solutions

opensipscli-0.3.1.dist-info/RECORD

@@ -0,0 +1,28 @@
+opensipscli/__init__.py,sha256=6Z2ET3BI44KCY0QUESzylWtRs3_UwL4uc_xL2suJUjs,798
+opensipscli/args.py,sha256=Kq86vRMqREqLj6NfcTd926LInNpN95f1ce6Y0WKFzo0,1589
+opensipscli/cli.py,sha256=6pDWTbUzRhpJ2C4RYLvxEp3GfM83cKs0ruHgJ1FZJ4g,16203
+opensipscli/comm.py,sha256=g0-kZxBjxjekCOARBc1Mhk06VG2G3bSFxFzzZDlJu_E,1839
+opensipscli/config.py,sha256=uvPTGofjmH6AHnETOJ5amBys1W1W2F0vFFB1AVfI9Cw,5530
+opensipscli/db.py,sha256=BMynjtnTYR55d1jICQ4NGbFw0hZjWu9MFzR-tmtiMoA,34480
+opensipscli/defaults.py,sha256=A0M9HhO_VZTkp0tlTzmFnrPaE7jJoBS_mZHT1am2rZM,2601
+opensipscli/logger.py,sha256=tP7_yp17R5a6W1Qcpk5xG0K_krd_IyznwObYbtw93yQ,2728
+opensipscli/main.py,sha256=UE6dlE1TE3PCuC17gt_gxqeY26QxoXPhgfK5U9FvxZA,3241
+opensipscli/module.py,sha256=qZrL5giIncwQsJ_GYsOryCYB2i6uZ1jGRgcDcn-efeE,2308
+opensipscli/version.py,sha256=d9Wcli7rDEgqY19HFh2gVgTCF6c7UTlkviAtHsSwoiM,842
+opensipscli/libs/__init__.py,sha256=ZTn6Sx1WtBE2_DiYc6R1E8QXJcOXOxeLUw5E45gvzxY,811
+opensipscli/libs/sqlalchemy_utils.py,sha256=28qUGMfOO5f6cJ0bwFqUsyg-joRVwXMJM_5QAjWr0OI,8756
+opensipscli/modules/__init__.py,sha256=L1JxeMhlOyxfRDHrSvlioAoIdvpsK4X9ySrFhUoOihA,947
+opensipscli/modules/database.py,sha256=LrnWfEL8qN2tOXaLQbHuW3fJ0nKMOCn7fX5-1oUQAvg,31324
+opensipscli/modules/diagnose.py,sha256=KEHORYtmoWeSOlEbO6o_ZPfZzDQ7JCiN-54JGDonOkk,38924
+opensipscli/modules/instance.py,sha256=1B9cr6cpwGCRY03xA4LGF2adtsc9yxahS5wjlX6tJUE,1828
+opensipscli/modules/mi.py,sha256=jMYXKX6LimGWaMTejfubcIQMEyRbN09q5Xxygh7O1v8,7156
+opensipscli/modules/tls.py,sha256=ruuvWN_C1gZBNV8RU6kqchEZWkzl_uVV6DQ19lW6Ul0,13144
+opensipscli/modules/trace.py,sha256=TZginhQRUKXAjGG73ks5jlkS8yfxjf-qy5TbHecrsPE,9910
+opensipscli/modules/trap.py,sha256=7PTwgSzjXhMz8iF7Xlr5_wQcmqt_G-q16lGZQreBL2k,4899
+opensipscli/modules/user.py,sha256=BKA2ZAtBSFKYSw1m5zXziRDKDbtSZQieArqAj33qTDY,9731
+opensipscli-0.3.1.data/scripts/opensips-cli,sha256=MBWQGtfrRCHDAz2F3C5Pxk9FJ04-g8e5KoGRpgBHE4I,121
+opensipscli-0.3.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+opensipscli-0.3.1.dist-info/METADATA,sha256=n1xMywKi5PxK2VCT6mZKeIBY4WzdxdDobey-cjUhjkg,9513
+opensipscli-0.3.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+opensipscli-0.3.1.dist-info/top_level.txt,sha256=ngBDjeE6-dpEr_7WF1J3wM4r33TjJpegoGWiU0sq0UQ,12
+opensipscli-0.3.1.dist-info/RECORD,,

opensipscli-0.3.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

opensipscli-0.3.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+opensipscli