server-system-monitor


Nameserver-system-monitor JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA server system monitor for linux to linux
upload_time2025-01-30 02:02:28
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseThe MIT License (MIT) Copyright (c) 2025 Flávio Borges de Lima Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords monitor system server remote
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Server System Monitor

This is package can monitor a server ping, CPU and memory using SSH, but in a short time it will be able to monitor disk usage.

All of the methods are wrappers to common Linux commands like:

```python
Monitor.from_user_password("example.com","pwd","user").server_client.send_ram()
```

is the same as:

```shell
ssh user@example.com "free"
```

## Commands and wrappers

`ConnectionMonitor` wrappers:

| command | wrapper  |
| ------- | -------- |
| ping    | get_ping |

`ServerClientMonitor` wrappers:

| command | wrapper  |
| ------- | -------- |
| free    | send_ram |
| mpstat  | send_cpu |

## Quick usage

For monitoring connection specs and server's system specs at the same time you can use the `Monitor` object:

```python
from server_system_monitor import Monitor

monitor = Monitor.from_user_password("example.com","pwd","user")

ram = monitor.server_client.send_ram()

ping = monitor.connection.get_ping()

print(ram)
print(ping)
```

But if only one is necessary you can use `ConnectionMonitor` (for connection specs) or `ServerClientMonitor` (for server specs):

```python
from server_system_monitor import ServerClientMonitor,ConnectionMonitor

server_client_monitor = ServerClientMonitor.from_user_password("example.com","pwd","user")

connection_monitor = ConnectionMonitor("example.com")

ram = server_client_monitor.send_ram()

ping = connection_monitor.get_ping()

print(ram)
print(ping)
```

## License

The server-system-monitor library is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "server-system-monitor",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "FaboBorgesLima <fabo.borges.lima@gmail.com>",
    "keywords": "monitor, system, server, remote",
    "author": null,
    "author_email": "FaboBorgesLima <fabo.borges.lima@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/0a/24/f07ad491135a5922cd55d321bc7258b863c3c176a7474e9fb7fdf16e18d4/server_system_monitor-0.1.0.tar.gz",
    "platform": null,
    "description": "# Server System Monitor\n\nThis is package can monitor a server ping, CPU and memory using SSH, but in a short time it will be able to monitor disk usage.\n\nAll of the methods are wrappers to common Linux commands like:\n\n```python\nMonitor.from_user_password(\"example.com\",\"pwd\",\"user\").server_client.send_ram()\n```\n\nis the same as:\n\n```shell\nssh user@example.com \"free\"\n```\n\n## Commands and wrappers\n\n`ConnectionMonitor` wrappers:\n\n| command | wrapper  |\n| ------- | -------- |\n| ping    | get_ping |\n\n`ServerClientMonitor` wrappers:\n\n| command | wrapper  |\n| ------- | -------- |\n| free    | send_ram |\n| mpstat  | send_cpu |\n\n## Quick usage\n\nFor monitoring connection specs and server's system specs at the same time you can use the `Monitor` object:\n\n```python\nfrom server_system_monitor import Monitor\n\nmonitor = Monitor.from_user_password(\"example.com\",\"pwd\",\"user\")\n\nram = monitor.server_client.send_ram()\n\nping = monitor.connection.get_ping()\n\nprint(ram)\nprint(ping)\n```\n\nBut if only one is necessary you can use `ConnectionMonitor` (for connection specs) or `ServerClientMonitor` (for server specs):\n\n```python\nfrom server_system_monitor import ServerClientMonitor,ConnectionMonitor\n\nserver_client_monitor = ServerClientMonitor.from_user_password(\"example.com\",\"pwd\",\"user\")\n\nconnection_monitor = ConnectionMonitor(\"example.com\")\n\nram = server_client_monitor.send_ram()\n\nping = connection_monitor.get_ping()\n\nprint(ram)\nprint(ping)\n```\n\n## License\n\nThe server-system-monitor library is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)\n        \n        Copyright (c) 2025 Fl\u00e1vio Borges de Lima\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "A server system monitor for linux to linux",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "monitor",
        " system",
        " server",
        " remote"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "736ef47b8c1038ae7804cab5c468c9d0b05496716cc0f6f3b8775b8966a29f4e",
                "md5": "acdb6b56c0b4114f4ca047083b2dc45b",
                "sha256": "48fccc271b850858c334530bd9dbe9bcecc9a209928c28c7cf94d92dcc26148c"
            },
            "downloads": -1,
            "filename": "server_system_monitor-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "acdb6b56c0b4114f4ca047083b2dc45b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5782,
            "upload_time": "2025-01-30T02:02:26",
            "upload_time_iso_8601": "2025-01-30T02:02:26.884482Z",
            "url": "https://files.pythonhosted.org/packages/73/6e/f47b8c1038ae7804cab5c468c9d0b05496716cc0f6f3b8775b8966a29f4e/server_system_monitor-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0a24f07ad491135a5922cd55d321bc7258b863c3c176a7474e9fb7fdf16e18d4",
                "md5": "03785d27bd9b25e85fc7ab66c7b9dbb4",
                "sha256": "c25dfb2a5347c13bd8e61945c748b38e4bfb8c1fc9e08ec77d68577ef7cbccb9"
            },
            "downloads": -1,
            "filename": "server_system_monitor-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "03785d27bd9b25e85fc7ab66c7b9dbb4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4600,
            "upload_time": "2025-01-30T02:02:28",
            "upload_time_iso_8601": "2025-01-30T02:02:28.939464Z",
            "url": "https://files.pythonhosted.org/packages/0a/24/f07ad491135a5922cd55d321bc7258b863c3c176a7474e9fb7fdf16e18d4/server_system_monitor-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-30 02:02:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "server-system-monitor"
}
        
Elapsed time: 1.62526s