# marzbanpy
An unofficial package for marzban panel
## Donation
This project was and is being written under a beer :)
If you want to support me and help the development of the project, here are ways to donate:
- BTC: `bc1qmrwu6uv00xcvsjvjkwnaw2ky6aenhjgqewg0w4`
- USDT (TRC-20): `TJUUhJpeaZBBXpG6yUtzLsQmT3XQjViowV`
- ETH: `0x052D18812fA247Ce6853a6D95213CEbdb45c6277`
- BANK CARD (RU): `5536 9139 1278 5017`
## Installation
```shell
pip install marzbanpy
```
## Usage example
```python
import asyncio
from marzbanpy import Marzban
from marzbanpy.types import User
Marzban.setup('https://xray.penetrates.everything', 'admin', 'GodSaveTheQueen')
async def main():
admin_token = await Marzban.get_token()
admin_token = await Marzban.get_token(renewal=True)
users: list[User] = await User.all()
print(len(users))
print(users[:5])
user: User = await User.create(
username='example',
proxies={},
inbounds={},
status='active',
expire=0
)
print(user) # {'username': 'example', 'proxies': {}, ...}
user['status'] = 'disabled'
await user.save()
await user.delete()
asyncio.run(main())
```
## License
The project is under the [MIT](https://github.com/YoungVPN/marzbanpy/blob/main/LICENSE) licence
## Contacts
Email: <bertollo@gunship.su>
Telegram: [@blackbloodredkiss](https://t.me/blackbloodredkiss)
Raw data
{
"_id": null,
"home_page": "https://github.com/YoungVPN/marzbanpy",
"name": "marzbanpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "marzban api x-ui hiddify vpn proxy vless vmess shadowsocks",
"author": "gunsh1p",
"author_email": "bertollo@gunship.su",
"download_url": "https://files.pythonhosted.org/packages/c6/ef/6e20a8968dcea5c537f523cc584545ffae20132e3068f5b74fdf6dfbd215/marzbanpy-0.1.tar.gz",
"platform": null,
"description": "# marzbanpy\nAn unofficial package for marzban panel\n\n## Donation\nThis project was and is being written under a beer :)\n\nIf you want to support me and help the development of the project, here are ways to donate:\n\n- BTC: `bc1qmrwu6uv00xcvsjvjkwnaw2ky6aenhjgqewg0w4`\n\n- USDT (TRC-20): `TJUUhJpeaZBBXpG6yUtzLsQmT3XQjViowV`\n\n- ETH: `0x052D18812fA247Ce6853a6D95213CEbdb45c6277`\n\n- BANK CARD (RU): `5536 9139 1278 5017`\n\n## Installation\n```shell\npip install marzbanpy\n```\n\n## Usage example\n\n```python\nimport asyncio\n\nfrom marzbanpy import Marzban\nfrom marzbanpy.types import User\n\nMarzban.setup('https://xray.penetrates.everything', 'admin', 'GodSaveTheQueen')\n\nasync def main():\n admin_token = await Marzban.get_token()\n admin_token = await Marzban.get_token(renewal=True)\n users: list[User] = await User.all()\n print(len(users))\n print(users[:5])\n user: User = await User.create(\n username='example',\n proxies={},\n inbounds={},\n status='active',\n expire=0\n )\n print(user) # {'username': 'example', 'proxies': {}, ...}\n user['status'] = 'disabled'\n await user.save()\n await user.delete()\n\nasyncio.run(main())\n\n```\n\n## License\n\nThe project is under the [MIT](https://github.com/YoungVPN/marzbanpy/blob/main/LICENSE) licence\n\n## Contacts\n\nEmail: <bertollo@gunship.su>\n\nTelegram: [@blackbloodredkiss](https://t.me/blackbloodredkiss)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "An unofficial package for marzban panel",
"version": "0.1",
"project_urls": {
"GitHub": "https://github.com/YoungVPN/marzbanpy",
"Homepage": "https://github.com/YoungVPN/marzbanpy"
},
"split_keywords": [
"marzban",
"api",
"x-ui",
"hiddify",
"vpn",
"proxy",
"vless",
"vmess",
"shadowsocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2ceceef82cdbe28a6f3b7fffb7cb0c4633ef49b4a6333ee9b18791dcf11a398",
"md5": "e98b1e62c3dc3ea7e55dd02ec4ed33c6",
"sha256": "27dad2c7b3332c86e375db1e9e6117b801d01c4ae088a7ed9ce6de3eb787ce33"
},
"downloads": -1,
"filename": "marzbanpy-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e98b1e62c3dc3ea7e55dd02ec4ed33c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7708,
"upload_time": "2024-03-25T20:59:51",
"upload_time_iso_8601": "2024-03-25T20:59:51.505194Z",
"url": "https://files.pythonhosted.org/packages/e2/ce/ceef82cdbe28a6f3b7fffb7cb0c4633ef49b4a6333ee9b18791dcf11a398/marzbanpy-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6ef6e20a8968dcea5c537f523cc584545ffae20132e3068f5b74fdf6dfbd215",
"md5": "0f7979e6c89fe7578e0322d126483bd2",
"sha256": "f918a43aec8e314045dcf92d81a42130b59b68c81d95cb537661b11dd65d4637"
},
"downloads": -1,
"filename": "marzbanpy-0.1.tar.gz",
"has_sig": false,
"md5_digest": "0f7979e6c89fe7578e0322d126483bd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5941,
"upload_time": "2024-03-25T20:59:53",
"upload_time_iso_8601": "2024-03-25T20:59:53.368083Z",
"url": "https://files.pythonhosted.org/packages/c6/ef/6e20a8968dcea5c537f523cc584545ffae20132e3068f5b74fdf6dfbd215/marzbanpy-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 20:59:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "YoungVPN",
"github_project": "marzbanpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "marzbanpy"
}
JSON
