<div align="center">
<h1><a href="https://github.com/PlumaCompanyLtd/PyXrayC"><b>PyXrayC</b></a></h1>
<a href="https://github.com/PlumaCompanyLtd/PyXrayC/actions?query=workflow%3APublish" target="_blank">
<img src="https://github.com/PlumaCompanyLtd/PyXrayC/workflows/Publish/badge.svg" alt="Publish">
</a>
<a href="https://www.python.org">
<img src="https://img.shields.io/pypi/pyversions/pyxrayc.svg" alt="Python Versions">
</a>
<a href="https://github.com/PlumaCompanyLtd/PyXrayC">
<img src="https://img.shields.io/pypi/v/pyxrayc.svg" alt="PyPI Version">
</a>
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/static/v1?label=code%20style&message=black&color=black&style=flat" alt="Code Style: black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat" alt="pre-commit">
</a>
</div>
## Introduction
_PyXrayC_ is a CLI tool built with Python and [Typer] library that helps you to manage your [Xray] VPN server's user
accounts with ease.
## Features
- Installable via `pip`
- Fully type hinted and extensible code base.
- User friendly and easy to use interface.
- Optional shell autocompletion.
- Add, view or delete users to/from your config file.
## Requirements
- A Linux distribution with [Xray] VPN server installed on it.
- Python 3.8 or higher.
## Installation
You can install _PyXrayC_ from [PyPI](https://pypi.org/project/pyxrayc/) using pip:
```bash
$ pip3 install pyxrayc
```
## Usage
You can see _PyXrayC_'s help message by running:
```bash
$ pyxrayc --help
```
## Configuration
_PyXrayC_ uses below environment variables as its configuration:
- `XRAY_CONFIG_PATH`: Path to the config file. Default: `/usr/local/etc/xray/config.json`
- `XRAY_BACKUP_PATH`: Path to the backup file. Default: `/usr/local/etc/xray/backup.json`
## License
This project is licensed under the terms of the [GPL-3.0] licence.
<p align="center">— ⚡ —</p>
<!-- Links -->
[GPL-3.0]: https://www.gnu.org/licenses/gpl-3.0.en.html "GNU General Public License v3.0"
[typer]: https://github.com/tiangolo/typer "Typer, build great CLIs. Easy to code. Based on Python type hints."
[xray]: https://github.com/XTLS "Project X"
Raw data
{
"_id": null,
"home_page": "https://github.com/PlumaCompanyLtd/PyXrayC",
"name": "pyxrayc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "xray,cli,management",
"author": "Seyed",
"author_email": "pyseyed@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/94/6d/008a7b2ab197e34518b945095c4f1376f74e25843c3837c52897e1c86c73/pyxrayc-0.1.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<h1><a href=\"https://github.com/PlumaCompanyLtd/PyXrayC\"><b>PyXrayC</b></a></h1>\n<a href=\"https://github.com/PlumaCompanyLtd/PyXrayC/actions?query=workflow%3APublish\" target=\"_blank\">\n <img src=\"https://github.com/PlumaCompanyLtd/PyXrayC/workflows/Publish/badge.svg\" alt=\"Publish\">\n</a>\n<a href=\"https://www.python.org\">\n <img src=\"https://img.shields.io/pypi/pyversions/pyxrayc.svg\" alt=\"Python Versions\">\n</a>\n<a href=\"https://github.com/PlumaCompanyLtd/PyXrayC\">\n <img src=\"https://img.shields.io/pypi/v/pyxrayc.svg\" alt=\"PyPI Version\">\n</a>\n<a href=\"https://github.com/psf/black\">\n <img src=\"https://img.shields.io/static/v1?label=code%20style&message=black&color=black&style=flat\" alt=\"Code Style: black\">\n</a>\n<a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat\" alt=\"pre-commit\">\n</a>\n</div>\n\n## Introduction\n\n_PyXrayC_ is a CLI tool built with Python and [Typer] library that helps you to manage your [Xray] VPN server's user\naccounts with ease.\n\n## Features\n\n- Installable via `pip`\n- Fully type hinted and extensible code base.\n- User friendly and easy to use interface.\n- Optional shell autocompletion.\n- Add, view or delete users to/from your config file.\n\n## Requirements\n\n- A Linux distribution with [Xray] VPN server installed on it.\n- Python 3.8 or higher.\n\n## Installation\n\nYou can install _PyXrayC_ from [PyPI](https://pypi.org/project/pyxrayc/) using pip:\n\n```bash\n$ pip3 install pyxrayc\n```\n\n## Usage\n\nYou can see _PyXrayC_'s help message by running:\n\n```bash\n$ pyxrayc --help\n```\n\n## Configuration\n\n_PyXrayC_ uses below environment variables as its configuration:\n\n- `XRAY_CONFIG_PATH`: Path to the config file. Default: `/usr/local/etc/xray/config.json`\n- `XRAY_BACKUP_PATH`: Path to the backup file. Default: `/usr/local/etc/xray/backup.json`\n\n## License\n\nThis project is licensed under the terms of the [GPL-3.0] licence.\n\n<p align=\"center\">— \u26a1 —</p>\n\n<!-- Links -->\n\n[GPL-3.0]: https://www.gnu.org/licenses/gpl-3.0.en.html \"GNU General Public License v3.0\"\n[typer]: https://github.com/tiangolo/typer \"Typer, build great CLIs. Easy to code. Based on Python type hints.\"\n[xray]: https://github.com/XTLS \"Project X\"\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "CLI utility for managing Xray VPN server user accounts with ease, written in Python.",
"version": "0.1.3",
"split_keywords": [
"xray",
"cli",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "17cff8710079c414d0aadbb89c0c3ec9",
"sha256": "cee0441bd0cff1095b9e5d8f13949ecfe6b8dfb00859c3c7dac2de27eb2ae32e"
},
"downloads": -1,
"filename": "pyxrayc-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17cff8710079c414d0aadbb89c0c3ec9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 30885,
"upload_time": "2022-12-14T12:17:28",
"upload_time_iso_8601": "2022-12-14T12:17:28.684650Z",
"url": "https://files.pythonhosted.org/packages/ff/f4/3844fda717e2ab79bf9b478baeb8feceea52e3b875ab9782d914cd891397/pyxrayc-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "9e93f229ce1708dc993eda788e86f945",
"sha256": "6c775910864536b1c22e12a2c8b697eb0d3056b21408456cabcbea7a78becaa3"
},
"downloads": -1,
"filename": "pyxrayc-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "9e93f229ce1708dc993eda788e86f945",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 17964,
"upload_time": "2022-12-14T12:17:30",
"upload_time_iso_8601": "2022-12-14T12:17:30.293431Z",
"url": "https://files.pythonhosted.org/packages/94/6d/008a7b2ab197e34518b945095c4f1376f74e25843c3837c52897e1c86c73/pyxrayc-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 12:17:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "PlumaCompanyLtd",
"github_project": "PyXrayC",
"lcname": "pyxrayc"
}
JSON
