| Name | marzbanpy JSON |
| Version |
1.0.5
JSON |
| download |
| home_page | None |
| Summary | An unofficial library for marzban panel |
| upload_time | 2024-08-07 23:33:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 gunship 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 |
marzban
shadowsocks
trojan
vless
vmess
xray
xray-core
xtls
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# marzbanpy
An unofficial library for marzban panel
## Install
```sh
pip install marzbanpy
```
## Example
```python
import asyncio
from marzbanpy import Marzban
from marzbanpy.types import User
from marzbanpy.enums.user import UserStatus
async def main():
panel = Marzban(
host="example.com",
port=443,
ssl=True,
username="admin",
password="admin123"
)
await panel.auth()
users = await User.all(
panel,
offset=10,
limit=10,
status=UserStatus.ACTIVE
)
print(users)
asyncio.run(main())
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Donation
- BTC: `bc1qmrwu6uv00xcvsjvjkwnaw2ky6aenhjgqewg0w4`
- USDT (TRC-20): `TT8HPQHdWTqk2QgAx6S6hYgCmgCip19D1Z`
### License
The project is under the [MIT](https://github.com/gunsh1p/marzbanpy/blob/main/LICENSE) licence
### Contacts
Telegram Channel: [@thegatesofdisorder](https://t.me/thegatesofdisorder)
Raw data
{
"_id": null,
"home_page": null,
"name": "marzbanpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "marzban, shadowsocks, trojan, vless, vmess, xray, xray-core, xtls",
"author": null,
"author_email": "\u0411\u0435\u0440\u0442\u043e\u043b\u043b\u043e \u0412\u0438\u043a\u0442\u043e\u0440 <bertollo.victor@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7a/05/6bfa2934ceff6ebb7779f49dcf41c63dc0b8d4d5e1f4725a7286f8e627ee/marzbanpy-1.0.5.tar.gz",
"platform": null,
"description": "# marzbanpy\n\nAn unofficial library for marzban panel\n\n## Install\n\n```sh\npip install marzbanpy\n```\n\n## Example\n\n```python\nimport asyncio\n\nfrom marzbanpy import Marzban\nfrom marzbanpy.types import User\nfrom marzbanpy.enums.user import UserStatus\n\nasync def main():\n panel = Marzban(\n host=\"example.com\",\n port=443,\n ssl=True,\n username=\"admin\",\n password=\"admin123\"\n )\n await panel.auth()\n\n users = await User.all(\n panel, \n offset=10, \n limit=10, \n status=UserStatus.ACTIVE\n )\n print(users)\n\nasyncio.run(main())\n```\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### Donation\n\n- BTC: `bc1qmrwu6uv00xcvsjvjkwnaw2ky6aenhjgqewg0w4`\n- USDT (TRC-20): `TT8HPQHdWTqk2QgAx6S6hYgCmgCip19D1Z`\n\n### License\n\nThe project is under the [MIT](https://github.com/gunsh1p/marzbanpy/blob/main/LICENSE) licence\n\n### Contacts\n\nTelegram Channel: [@thegatesofdisorder](https://t.me/thegatesofdisorder)",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 gunship 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": "An unofficial library for marzban panel",
"version": "1.0.5",
"project_urls": {
"repository": "https://github.com/gunsh1p/marzbanpy/"
},
"split_keywords": [
"marzban",
" shadowsocks",
" trojan",
" vless",
" vmess",
" xray",
" xray-core",
" xtls"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "872d1165e2e064761dddd6e53b0543f18f057d6dcf70bf9bd3c1726cad786711",
"md5": "e98c2c86882171510e0d2bf8475919dd",
"sha256": "9b8fade7fa4c6c32d2ebfb44875b5fe74d5b745d19011168c54d54108c0142a2"
},
"downloads": -1,
"filename": "marzbanpy-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e98c2c86882171510e0d2bf8475919dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15174,
"upload_time": "2024-08-07T23:32:58",
"upload_time_iso_8601": "2024-08-07T23:32:58.868104Z",
"url": "https://files.pythonhosted.org/packages/87/2d/1165e2e064761dddd6e53b0543f18f057d6dcf70bf9bd3c1726cad786711/marzbanpy-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a056bfa2934ceff6ebb7779f49dcf41c63dc0b8d4d5e1f4725a7286f8e627ee",
"md5": "9f1c4b2434652865d3924929cb2c4f3b",
"sha256": "da7cf2b39fb036f02458fb29e4a56e3fe6d1c1022880f26bed0b3eea76c53a9d"
},
"downloads": -1,
"filename": "marzbanpy-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9f1c4b2434652865d3924929cb2c4f3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11078,
"upload_time": "2024-08-07T23:33:00",
"upload_time_iso_8601": "2024-08-07T23:33:00.523909Z",
"url": "https://files.pythonhosted.org/packages/7a/05/6bfa2934ceff6ebb7779f49dcf41c63dc0b8d4d5e1f4725a7286f8e627ee/marzbanpy-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-07 23:33:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gunsh1p",
"github_project": "marzbanpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "marzbanpy"
}
