# Fudan Utilities
- [Fudan Utilities](#fudan-utilities)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [Supplying your credentials](#supplying-your-credentials)
- [List of utilities](#list-of-utilities)
- [`fudan-grades`](#fudan-grades)
- [Develop](#develop)
- [See also](#see-also)
- [Credits](#credits)
## Installation
### pipx
This is the recommended installation method.
```
$ pipx install fudan-utils
```
### [pip](https://pypi.org/project/fudan-utils/)
```
$ pip install fudan-utils
```
## Supplying your credentials
Set the `FUDAN_PID` and `FUDAN_PW` environment variables to your Fudan ID and password.
```bash
export FUDAN_PID=18309990001
export FUDAN_PW='123456verysecure!!!'
```
## List of utilities
### `fudan-grades`
Logs in to jwfw.fudan.edu.cn and get grades from the site.
```
$ fudan-grades -h
usage: fudan-grades [-h]
Get Fudan grades from jwfw
options:
-h, --help show this help message and exit
-j, --json output in json format (default: False)
-t, --html-table output in html table format (default: False)
$ fudan-grades # don't forget to supply your credentials via environment variables
学年学期 课程代码 课程序号 课程名称 课程类别 学分 最终 绩点
----------- ---------- ------------- ---------- ------------ ------ ------ ------
2022-2023 2 GTHB139999 GTHB139999.01 毕业论文 专业必修课程 6 F 0
```
## Develop
```
$ git clone https://github.com/tddschn/fudan-utils.git
$ cd fudan-utils
$ poetry install
```
## See also
- https://github.com/tddschn/fudan-jwc-news
## Credits
- https://github.com/FDUCSLG/pafd-automated for reverse engineering the login process
Raw data
{
"_id": null,
"home_page": "https://github.com/tddschn/fudan-utils",
"name": "fudan-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "Fudan University",
"author": "Teddy Xinyuan Chen",
"author_email": "45612704+tddschn@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/a3/8f/71086ad971fd62621524feec0838a87dbe5cc17058dd0cc944cfa1ffa0b9/fudan_utils-0.1.8.tar.gz",
"platform": null,
"description": "# Fudan Utilities\n\n- [Fudan Utilities](#fudan-utilities)\n - [Installation](#installation)\n - [pipx](#pipx)\n - [pip](#pip)\n - [Supplying your credentials](#supplying-your-credentials)\n - [List of utilities](#list-of-utilities)\n - [`fudan-grades`](#fudan-grades)\n - [Develop](#develop)\n - [See also](#see-also)\n - [Credits](#credits)\n\n## Installation\n\n### pipx\n\nThis is the recommended installation method.\n\n```\n$ pipx install fudan-utils\n```\n\n### [pip](https://pypi.org/project/fudan-utils/)\n\n```\n$ pip install fudan-utils\n```\n\n## Supplying your credentials\n\nSet the `FUDAN_PID` and `FUDAN_PW` environment variables to your Fudan ID and password.\n\n```bash\nexport FUDAN_PID=18309990001\nexport FUDAN_PW='123456verysecure!!!'\n```\n\n## List of utilities\n\n### `fudan-grades`\n\nLogs in to jwfw.fudan.edu.cn and get grades from the site.\n\n```\n$ fudan-grades -h\n\nusage: fudan-grades [-h]\n\nGet Fudan grades from jwfw\n\noptions:\n -h, --help show this help message and exit\n -j, --json output in json format (default: False)\n -t, --html-table output in html table format (default: False)\n\n\n$ fudan-grades # don't forget to supply your credentials via environment variables\n\n\u5b66\u5e74\u5b66\u671f \u8bfe\u7a0b\u4ee3\u7801 \u8bfe\u7a0b\u5e8f\u53f7 \u8bfe\u7a0b\u540d\u79f0 \u8bfe\u7a0b\u7c7b\u522b \u5b66\u5206 \u6700\u7ec8 \u7ee9\u70b9\n----------- ---------- ------------- ---------- ------------ ------ ------ ------\n2022-2023 2 GTHB139999 GTHB139999.01 \u6bd5\u4e1a\u8bba\u6587 \u4e13\u4e1a\u5fc5\u4fee\u8bfe\u7a0b 6 F 0\n```\n\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/fudan-utils.git\n$ cd fudan-utils\n$ poetry install\n```\n\n## See also\n\n- https://github.com/tddschn/fudan-jwc-news\n\n## Credits\n\n- https://github.com/FDUCSLG/pafd-automated for reverse engineering the login process",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fudan UIS Login Utilities and More",
"version": "0.1.8",
"project_urls": {
"Bug Tracker": "https://github.com/tddschn/fudan-utils/issues",
"Homepage": "https://github.com/tddschn/fudan-utils",
"Repository": "https://github.com/tddschn/fudan-utils"
},
"split_keywords": [
"fudan",
"university"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a82a25038b7b74706ca1cfc7e33692b4b9a125ee3e7383664876f091c08578b7",
"md5": "e198e08438613eb4b46ac2b9e450f824",
"sha256": "507cfe4c36e4f364adf97c3e3b3f869183735efafcb929b2d38623659277d577"
},
"downloads": -1,
"filename": "fudan_utils-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e198e08438613eb4b46ac2b9e450f824",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 7047,
"upload_time": "2023-06-15T07:34:39",
"upload_time_iso_8601": "2023-06-15T07:34:39.234837Z",
"url": "https://files.pythonhosted.org/packages/a8/2a/25038b7b74706ca1cfc7e33692b4b9a125ee3e7383664876f091c08578b7/fudan_utils-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a38f71086ad971fd62621524feec0838a87dbe5cc17058dd0cc944cfa1ffa0b9",
"md5": "d8106b7ab2116d25d05f0ad38424afa7",
"sha256": "0773bbefb48c2651e7a7f9f6241aace6a108db7e2e8de10e626399d642757081"
},
"downloads": -1,
"filename": "fudan_utils-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "d8106b7ab2116d25d05f0ad38424afa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 5836,
"upload_time": "2023-06-15T07:34:41",
"upload_time_iso_8601": "2023-06-15T07:34:41.012646Z",
"url": "https://files.pythonhosted.org/packages/a3/8f/71086ad971fd62621524feec0838a87dbe5cc17058dd0cc944cfa1ffa0b9/fudan_utils-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 07:34:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tddschn",
"github_project": "fudan-utils",
"github_not_found": true,
"lcname": "fudan-utils"
}
JSON
