# NEU ipgw manager
当前版本：3.1.1
东北大学ipgw网关管理程序重制版，仅支持统一身份认证用户名-密码登录
- 漂亮的、格式化的表格输出，内容清晰易读，和网页端提供相同的信息。
- 兼容强，可以识别ipgw的所有状态和页面，比如停止服务、其他设备在线、费用不足等情况，并可以像网页端一样作出操作。
- 适配广泛，对于无线网络、有线网络、安卓/IOS/Windows设备都有很好的支持，你完全可以把它作为无界面服务器联网的工具，同时比浏览器使用方便很多。
- 支持多用户管理，带有配置文件，可以用简单的命令执行复杂的操作。当然也可以覆盖默认的行为。配置文件人类可读，修改起来很方便。
- 模拟真实浏览器操作，稳定运行多年，无任何使用风险。
- 不仅仅是一个网络登录程序，内置core模块可以非常容易的重用，代替实现各种校内网页认证等功能，非常方便。
使用此脚本管理自己的ipgw连接，可以加快操作ipgw网关的速度，节省时间，无论是联网还是断网都十分方便。
本项目承诺长期更新，长期可用，功能稳定。
11.2日校园网更新
2021.11.2，东北大学校园网迎来了一次更新。此次更新修改了后端的api接口以及原有的登录策略和校验逻辑。
2021.11.3，NEU-ipgw-manager更新到了3.0版本，适配了这个新的api。
2024.09.13, NEU-ipgw-manager更新到了3.1版本，将整个软件的框架和构建系统升级到最新的Python标准中，并简化了安装要求。
## 安装
### 自动安装
本软件已经发布到PyPI，只需要执行
```pip install NEU-ipgw-manager```
本项目支持从3.7开始的所有现代Python版本，项目本身是在Python 3.12上开发的。
### 手动安装
首先克隆本仓库的源代码
`git clone https://github.com/Neboer/ipgw-py-manager.git`
切换到文件夹中，`cd ipgw-py-manager`
然后执行`pip install .`从源代码安装本软件
这样，就可以直接在命令行中执行`ipgw --version`来确认安装了。
## 快速上手
配置文件在安装之后自动存放在用户的home目录，可以在--help输出的信息中查看。详细的命令行用法参见下面的信息。
对于首次安装的用户，你需要添加一个用户并设置其为默认用户，操作方法如下：
```shell
ipgw add -u 20180001
```
输入密码，成功添加用户。
```shell
ipgw default -u 20180001
```
成功设置用户为默认用户。
之后，登录网关：
```shell
ipgw i
```
如果用户名和密码没有问题，此时应该显示登录成功，并报告登录的结果。
登出：
```shell
ipgw o
```
快速登出当前登录的帐号。
## 命令行参数说明
`ipgw action [options...]`
看如下几个实例（示例学号为20200001）：
### 状态
```shell
ipgw status
ipgw s
```
获取当前ipgw网络连接状态。
### 登录
```shell
ipgw login
ipgw i
```
使用已保存的默认用户名密码登录并联网。在任何时候login都可以替换成i。
---
```shell
ipgw login -u 20200001
ipgw login --username 20200001
```
登录20200001，程序会在已保存的账号中寻找20200001的密码，如果找不到则会要求用户输入密码。
---
```shell
ipgw login -u 20200001 --password thepassword
ipgw login -u 20200001 -p thepassword
```
使用指定密码登录账号，不推荐此类方法，建议不要在命令行中直接输入密码。
登录之后，程序会显示账号信息列表和已登录设备列表。
### 登出
```shell
ipgw logout
ipgw o
```
登出本机。
---
```shell
ipgw logout --all
ipgw o --all
```
下线所有设备。
### 账号管理
```shell
ipgw add 20200001 -p thepassword
```
与login行为基本相同，-p应该省略，由用户手动输入。
```shell
ipgw default -u 20200001
```
在添加用户之后，使用default命令将此用户设为默认登录用户。
程序**不提供**删除账号、修改密码等对已保存账号进行操作的功能，有类似需求的时候请直接编辑配置文件。
### 详细输出
程序支持详细日志输出，如果程序出现异常，可以添加`-v`或者`--verbose`选项让程序输出更详细的日志，供debug使用。
Raw data
{
"_id": null,
"home_page": null,
"name": "NEU-ipgw-manager",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "NEU, \u4e1c\u5317\u5927\u5b66, ipgw, \u7f51\u5173, northeastern university",
"author": null,
"author_email": "Neboer <rubinposter@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3c/c6/b44d4a8eaf4715ca10e939e83088a28c4cbeaf141a0e310f04c442b83fd8/neu_ipgw_manager-3.1.3.tar.gz",
"platform": null,
"description": "# NEU ipgw manager\n\n\n\n\n\n\u5f53\u524d\u7248\u672c\uff1a3.1.1\n\n\u4e1c\u5317\u5927\u5b66ipgw\u7f51\u5173\u7ba1\u7406\u7a0b\u5e8f\u91cd\u5236\u7248\uff0c\u4ec5\u652f\u6301\u7edf\u4e00\u8eab\u4efd\u8ba4\u8bc1\u7528\u6237\u540d-\u5bc6\u7801\u767b\u5f55\n\n- \u6f02\u4eae\u7684\u3001\u683c\u5f0f\u5316\u7684\u8868\u683c\u8f93\u51fa\uff0c\u5185\u5bb9\u6e05\u6670\u6613\u8bfb\uff0c\u548c\u7f51\u9875\u7aef\u63d0\u4f9b\u76f8\u540c\u7684\u4fe1\u606f\u3002\n- \u517c\u5bb9\u5f3a\uff0c\u53ef\u4ee5\u8bc6\u522bipgw\u7684\u6240\u6709\u72b6\u6001\u548c\u9875\u9762\uff0c\u6bd4\u5982\u505c\u6b62\u670d\u52a1\u3001\u5176\u4ed6\u8bbe\u5907\u5728\u7ebf\u3001\u8d39\u7528\u4e0d\u8db3\u7b49\u60c5\u51b5\uff0c\u5e76\u53ef\u4ee5\u50cf\u7f51\u9875\u7aef\u4e00\u6837\u4f5c\u51fa\u64cd\u4f5c\u3002\n- \u9002\u914d\u5e7f\u6cdb\uff0c\u5bf9\u4e8e\u65e0\u7ebf\u7f51\u7edc\u3001\u6709\u7ebf\u7f51\u7edc\u3001\u5b89\u5353/IOS/Windows\u8bbe\u5907\u90fd\u6709\u5f88\u597d\u7684\u652f\u6301\uff0c\u4f60\u5b8c\u5168\u53ef\u4ee5\u628a\u5b83\u4f5c\u4e3a\u65e0\u754c\u9762\u670d\u52a1\u5668\u8054\u7f51\u7684\u5de5\u5177\uff0c\u540c\u65f6\u6bd4\u6d4f\u89c8\u5668\u4f7f\u7528\u65b9\u4fbf\u5f88\u591a\u3002\n- \u652f\u6301\u591a\u7528\u6237\u7ba1\u7406\uff0c\u5e26\u6709\u914d\u7f6e\u6587\u4ef6\uff0c\u53ef\u4ee5\u7528\u7b80\u5355\u7684\u547d\u4ee4\u6267\u884c\u590d\u6742\u7684\u64cd\u4f5c\u3002\u5f53\u7136\u4e5f\u53ef\u4ee5\u8986\u76d6\u9ed8\u8ba4\u7684\u884c\u4e3a\u3002\u914d\u7f6e\u6587\u4ef6\u4eba\u7c7b\u53ef\u8bfb\uff0c\u4fee\u6539\u8d77\u6765\u5f88\u65b9\u4fbf\u3002\n- \u6a21\u62df\u771f\u5b9e\u6d4f\u89c8\u5668\u64cd\u4f5c\uff0c\u7a33\u5b9a\u8fd0\u884c\u591a\u5e74\uff0c\u65e0\u4efb\u4f55\u4f7f\u7528\u98ce\u9669\u3002\n- \u4e0d\u4ec5\u4ec5\u662f\u4e00\u4e2a\u7f51\u7edc\u767b\u5f55\u7a0b\u5e8f\uff0c\u5185\u7f6ecore\u6a21\u5757\u53ef\u4ee5\u975e\u5e38\u5bb9\u6613\u7684\u91cd\u7528\uff0c\u4ee3\u66ff\u5b9e\u73b0\u5404\u79cd\u6821\u5185\u7f51\u9875\u8ba4\u8bc1\u7b49\u529f\u80fd\uff0c\u975e\u5e38\u65b9\u4fbf\u3002\n\n\u4f7f\u7528\u6b64\u811a\u672c\u7ba1\u7406\u81ea\u5df1\u7684ipgw\u8fde\u63a5\uff0c\u53ef\u4ee5\u52a0\u5feb\u64cd\u4f5cipgw\u7f51\u5173\u7684\u901f\u5ea6\uff0c\u8282\u7701\u65f6\u95f4\uff0c\u65e0\u8bba\u662f\u8054\u7f51\u8fd8\u662f\u65ad\u7f51\u90fd\u5341\u5206\u65b9\u4fbf\u3002\n\n\u672c\u9879\u76ee\u627f\u8bfa\u957f\u671f\u66f4\u65b0\uff0c\u957f\u671f\u53ef\u7528\uff0c\u529f\u80fd\u7a33\u5b9a\u3002\n\n11.2\u65e5\u6821\u56ed\u7f51\u66f4\u65b0\n2021.11.2\uff0c\u4e1c\u5317\u5927\u5b66\u6821\u56ed\u7f51\u8fce\u6765\u4e86\u4e00\u6b21\u66f4\u65b0\u3002\u6b64\u6b21\u66f4\u65b0\u4fee\u6539\u4e86\u540e\u7aef\u7684api\u63a5\u53e3\u4ee5\u53ca\u539f\u6709\u7684\u767b\u5f55\u7b56\u7565\u548c\u6821\u9a8c\u903b\u8f91\u3002\n2021.11.3\uff0cNEU-ipgw-manager\u66f4\u65b0\u5230\u4e863.0\u7248\u672c\uff0c\u9002\u914d\u4e86\u8fd9\u4e2a\u65b0\u7684api\u3002\n2024.09.13, NEU-ipgw-manager\u66f4\u65b0\u5230\u4e863.1\u7248\u672c\uff0c\u5c06\u6574\u4e2a\u8f6f\u4ef6\u7684\u6846\u67b6\u548c\u6784\u5efa\u7cfb\u7edf\u5347\u7ea7\u5230\u6700\u65b0\u7684Python\u6807\u51c6\u4e2d\uff0c\u5e76\u7b80\u5316\u4e86\u5b89\u88c5\u8981\u6c42\u3002\n\n## \u5b89\u88c5\n### \u81ea\u52a8\u5b89\u88c5\n\u672c\u8f6f\u4ef6\u5df2\u7ecf\u53d1\u5e03\u5230PyPI\uff0c\u53ea\u9700\u8981\u6267\u884c\n\n```pip install NEU-ipgw-manager```\n\n\u672c\u9879\u76ee\u652f\u6301\u4ece3.7\u5f00\u59cb\u7684\u6240\u6709\u73b0\u4ee3Python\u7248\u672c\uff0c\u9879\u76ee\u672c\u8eab\u662f\u5728Python 3.12\u4e0a\u5f00\u53d1\u7684\u3002\n\n### \u624b\u52a8\u5b89\u88c5\n\u9996\u5148\u514b\u9686\u672c\u4ed3\u5e93\u7684\u6e90\u4ee3\u7801\n\n`git clone https://github.com/Neboer/ipgw-py-manager.git`\n\n\u5207\u6362\u5230\u6587\u4ef6\u5939\u4e2d\uff0c`cd ipgw-py-manager`\n\n\u7136\u540e\u6267\u884c`pip install .`\u4ece\u6e90\u4ee3\u7801\u5b89\u88c5\u672c\u8f6f\u4ef6\n\n\u8fd9\u6837\uff0c\u5c31\u53ef\u4ee5\u76f4\u63a5\u5728\u547d\u4ee4\u884c\u4e2d\u6267\u884c`ipgw --version`\u6765\u786e\u8ba4\u5b89\u88c5\u4e86\u3002\n\n## \u5feb\u901f\u4e0a\u624b\n\n\u914d\u7f6e\u6587\u4ef6\u5728\u5b89\u88c5\u4e4b\u540e\u81ea\u52a8\u5b58\u653e\u5728\u7528\u6237\u7684home\u76ee\u5f55\uff0c\u53ef\u4ee5\u5728--help\u8f93\u51fa\u7684\u4fe1\u606f\u4e2d\u67e5\u770b\u3002\u8be6\u7ec6\u7684\u547d\u4ee4\u884c\u7528\u6cd5\u53c2\u89c1\u4e0b\u9762\u7684\u4fe1\u606f\u3002\n\n\u5bf9\u4e8e\u9996\u6b21\u5b89\u88c5\u7684\u7528\u6237\uff0c\u4f60\u9700\u8981\u6dfb\u52a0\u4e00\u4e2a\u7528\u6237\u5e76\u8bbe\u7f6e\u5176\u4e3a\u9ed8\u8ba4\u7528\u6237\uff0c\u64cd\u4f5c\u65b9\u6cd5\u5982\u4e0b\uff1a\n\n```shell\nipgw add -u 20180001\n```\n\n\u8f93\u5165\u5bc6\u7801\uff0c\u6210\u529f\u6dfb\u52a0\u7528\u6237\u3002\n\n```shell\nipgw default -u 20180001\n```\n\n\u6210\u529f\u8bbe\u7f6e\u7528\u6237\u4e3a\u9ed8\u8ba4\u7528\u6237\u3002\n\n\u4e4b\u540e\uff0c\u767b\u5f55\u7f51\u5173\uff1a\n\n```shell\nipgw i\n```\n\n\u5982\u679c\u7528\u6237\u540d\u548c\u5bc6\u7801\u6ca1\u6709\u95ee\u9898\uff0c\u6b64\u65f6\u5e94\u8be5\u663e\u793a\u767b\u5f55\u6210\u529f\uff0c\u5e76\u62a5\u544a\u767b\u5f55\u7684\u7ed3\u679c\u3002\n\n\u767b\u51fa\uff1a\n\n```shell\nipgw o\n```\n\n\u5feb\u901f\u767b\u51fa\u5f53\u524d\u767b\u5f55\u7684\u5e10\u53f7\u3002\n\n## \u547d\u4ee4\u884c\u53c2\u6570\u8bf4\u660e\n\n`ipgw action [options...]`\n\n\u770b\u5982\u4e0b\u51e0\u4e2a\u5b9e\u4f8b\uff08\u793a\u4f8b\u5b66\u53f7\u4e3a20200001\uff09\uff1a\n\n### \u72b6\u6001\n\n```shell\nipgw status\nipgw s\n```\n\n\u83b7\u53d6\u5f53\u524dipgw\u7f51\u7edc\u8fde\u63a5\u72b6\u6001\u3002\n\n### \u767b\u5f55\n\n```shell\nipgw login\nipgw i\n```\n\n\u4f7f\u7528\u5df2\u4fdd\u5b58\u7684\u9ed8\u8ba4\u7528\u6237\u540d\u5bc6\u7801\u767b\u5f55\u5e76\u8054\u7f51\u3002\u5728\u4efb\u4f55\u65f6\u5019login\u90fd\u53ef\u4ee5\u66ff\u6362\u6210i\u3002\n\n---\n\n```shell\nipgw login -u 20200001\nipgw login --username 20200001\n```\n\n\u767b\u5f5520200001\uff0c\u7a0b\u5e8f\u4f1a\u5728\u5df2\u4fdd\u5b58\u7684\u8d26\u53f7\u4e2d\u5bfb\u627e20200001\u7684\u5bc6\u7801\uff0c\u5982\u679c\u627e\u4e0d\u5230\u5219\u4f1a\u8981\u6c42\u7528\u6237\u8f93\u5165\u5bc6\u7801\u3002\n\n---\n\n```shell\nipgw login -u 20200001 --password thepassword\nipgw login -u 20200001 -p thepassword\n```\n\n\u4f7f\u7528\u6307\u5b9a\u5bc6\u7801\u767b\u5f55\u8d26\u53f7\uff0c\u4e0d\u63a8\u8350\u6b64\u7c7b\u65b9\u6cd5\uff0c\u5efa\u8bae\u4e0d\u8981\u5728\u547d\u4ee4\u884c\u4e2d\u76f4\u63a5\u8f93\u5165\u5bc6\u7801\u3002\n\n\u767b\u5f55\u4e4b\u540e\uff0c\u7a0b\u5e8f\u4f1a\u663e\u793a\u8d26\u53f7\u4fe1\u606f\u5217\u8868\u548c\u5df2\u767b\u5f55\u8bbe\u5907\u5217\u8868\u3002\n\n### \u767b\u51fa\n\n```shell\nipgw logout\nipgw o\n```\n\n\u767b\u51fa\u672c\u673a\u3002\n\n---\n\n```shell\nipgw logout --all\nipgw o --all\n```\n\n\u4e0b\u7ebf\u6240\u6709\u8bbe\u5907\u3002\n\n### \u8d26\u53f7\u7ba1\u7406\n\n```shell\nipgw add 20200001 -p thepassword\n```\n\n\u4e0elogin\u884c\u4e3a\u57fa\u672c\u76f8\u540c\uff0c-p\u5e94\u8be5\u7701\u7565\uff0c\u7531\u7528\u6237\u624b\u52a8\u8f93\u5165\u3002\n\n```shell\nipgw default -u 20200001\n```\n\n\u5728\u6dfb\u52a0\u7528\u6237\u4e4b\u540e\uff0c\u4f7f\u7528default\u547d\u4ee4\u5c06\u6b64\u7528\u6237\u8bbe\u4e3a\u9ed8\u8ba4\u767b\u5f55\u7528\u6237\u3002\n\n\u7a0b\u5e8f**\u4e0d\u63d0\u4f9b**\u5220\u9664\u8d26\u53f7\u3001\u4fee\u6539\u5bc6\u7801\u7b49\u5bf9\u5df2\u4fdd\u5b58\u8d26\u53f7\u8fdb\u884c\u64cd\u4f5c\u7684\u529f\u80fd\uff0c\u6709\u7c7b\u4f3c\u9700\u6c42\u7684\u65f6\u5019\u8bf7\u76f4\u63a5\u7f16\u8f91\u914d\u7f6e\u6587\u4ef6\u3002\n\n### \u8be6\u7ec6\u8f93\u51fa\n\n\u7a0b\u5e8f\u652f\u6301\u8be6\u7ec6\u65e5\u5fd7\u8f93\u51fa\uff0c\u5982\u679c\u7a0b\u5e8f\u51fa\u73b0\u5f02\u5e38\uff0c\u53ef\u4ee5\u6dfb\u52a0`-v`\u6216\u8005`--verbose`\u9009\u9879\u8ba9\u7a0b\u5e8f\u8f93\u51fa\u66f4\u8be6\u7ec6\u7684\u65e5\u5fd7\uff0c\u4f9bdebug\u4f7f\u7528\u3002\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ipgw manager for NEU network gateway",
"version": "3.1.3",
"project_urls": null,
"split_keywords": [
"neu",
" \u4e1c\u5317\u5927\u5b66",
" ipgw",
" \u7f51\u5173",
" northeastern university"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59f45131ef022403f883eee4344971d42977a449bc6834dbe9f26a31cf32a3cf",
"md5": "2228e3cf16d9e9f6bd5764f7e1561443",
"sha256": "e65c1113059e084a9a480185ef35f6da25916c47d6b3bb3e8e010007f9cec04a"
},
"downloads": -1,
"filename": "NEU_ipgw_manager-3.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2228e3cf16d9e9f6bd5764f7e1561443",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18260,
"upload_time": "2024-10-27T12:33:54",
"upload_time_iso_8601": "2024-10-27T12:33:54.296338Z",
"url": "https://files.pythonhosted.org/packages/59/f4/5131ef022403f883eee4344971d42977a449bc6834dbe9f26a31cf32a3cf/NEU_ipgw_manager-3.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cc6b44d4a8eaf4715ca10e939e83088a28c4cbeaf141a0e310f04c442b83fd8",
"md5": "272939a5436665e941047a979dca520e",
"sha256": "c3b7468ecf192380db1644264e636518b368ff966f96245e3cedfcef19baa3e9"
},
"downloads": -1,
"filename": "neu_ipgw_manager-3.1.3.tar.gz",
"has_sig": false,
"md5_digest": "272939a5436665e941047a979dca520e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 13780,
"upload_time": "2024-10-27T12:33:56",
"upload_time_iso_8601": "2024-10-27T12:33:56.248355Z",
"url": "https://files.pythonhosted.org/packages/3c/c6/b44d4a8eaf4715ca10e939e83088a28c4cbeaf141a0e310f04c442b83fd8/neu_ipgw_manager-3.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 12:33:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "neu-ipgw-manager"
}
JSON