| Name | python-outline JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | Simple and easy to use wrapper for the Outline API. |
| upload_time | 2024-01-01 15:57:38 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 Vladislav Fedin 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 |
python
python3
outline
outline vpn
shadowsocks
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
###################################################
python-outline - Python wrapper for Outline VPN API
###################################################
**python-outline** is a best python wrapper for `Outline API <https://raw.githubusercontent.com/Jigsaw-Code/outline-server/master/src/shadowbox/server/api.yml>`_.
It is a simple and easy to use wrapper for the Outline API.
**********
How to use
**********
.. code:: python
from outline.client import OutlineClient
client = OutlineClient(base_url="https://localhost:777/secretpath")
new_key = client.new()
new_key.rename("This is a new name")
# set a data limit of 1GB
new_key.change_data_limit(1000000000)
new_key.url("my key with 1GB limit")
# ss://example@example.com/?outline=1#my key with 1GB limit
Raw data
{
"_id": null,
"home_page": "",
"name": "python-outline",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,python3,outline,outline vpn,shadowsocks",
"author": "",
"author_email": "Vladislav Fedin <vlad@fedin7.ru>",
"download_url": "https://files.pythonhosted.org/packages/fa/62/b966f1010e6fcf6ee72f2f4eb75f9bef6d4b71e2dd2b272b518a9c30b2f8/python-outline-1.0.1.tar.gz",
"platform": null,
"description": "###################################################\npython-outline - Python wrapper for Outline VPN API\n###################################################\n\n**python-outline** is a best python wrapper for `Outline API <https://raw.githubusercontent.com/Jigsaw-Code/outline-server/master/src/shadowbox/server/api.yml>`_.\n\nIt is a simple and easy to use wrapper for the Outline API.\n\n**********\nHow to use\n**********\n\n.. code:: python\n\n from outline.client import OutlineClient\n\n client = OutlineClient(base_url=\"https://localhost:777/secretpath\")\n \n new_key = client.new()\n \n new_key.rename(\"This is a new name\")\n \n # set a data limit of 1GB\n new_key.change_data_limit(1000000000)\n \n new_key.url(\"my key with 1GB limit\")\n # ss://example@example.com/?outline=1#my key with 1GB limit\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Vladislav Fedin 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. ",
"summary": "Simple and easy to use wrapper for the Outline API.",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://python-outline.readthedocs.io/",
"Issues": "https://github.com/7vlad7/python-outline/issues",
"Repository": "https://github.com/7vlad7/python-outline.git"
},
"split_keywords": [
"python",
"python3",
"outline",
"outline vpn",
"shadowsocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33ccfdb63b7a8d8d3e71b05479e808368bc7102f6263506b745f1c4d8e8f0474",
"md5": "cd435bda697d8798279cf8602c39bbe5",
"sha256": "ba076e9dfa613ccda1b0caf3c4d25c4a4f101b334ad06e3ba8944d03349a4d72"
},
"downloads": -1,
"filename": "python_outline-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd435bda697d8798279cf8602c39bbe5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6106,
"upload_time": "2024-01-01T15:57:37",
"upload_time_iso_8601": "2024-01-01T15:57:37.247804Z",
"url": "https://files.pythonhosted.org/packages/33/cc/fdb63b7a8d8d3e71b05479e808368bc7102f6263506b745f1c4d8e8f0474/python_outline-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa62b966f1010e6fcf6ee72f2f4eb75f9bef6d4b71e2dd2b272b518a9c30b2f8",
"md5": "4afddb038dacc9c31a777757faf3dca0",
"sha256": "e3d73630c7d348b0c193159422ddcbb4d933213d78d343af00c19954dc0281a7"
},
"downloads": -1,
"filename": "python-outline-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4afddb038dacc9c31a777757faf3dca0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9272,
"upload_time": "2024-01-01T15:57:38",
"upload_time_iso_8601": "2024-01-01T15:57:38.928934Z",
"url": "https://files.pythonhosted.org/packages/fa/62/b966f1010e6fcf6ee72f2f4eb75f9bef6d4b71e2dd2b272b518a9c30b2f8/python-outline-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 15:57:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "7vlad7",
"github_project": "python-outline",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-outline"
}
