| Name | unirule JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Rule converter for proxy platforms. |
| upload_time | 2024-08-25 17:40:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# unirule
Rule converter for proxy platforms.
unirule supports rules in text formats only. For binary formats, we recommend [MetaCubeX/geo](https://github.com/MetaCubeX/geo).
## Install
unirule requires Python >= 3.10 .
```bash
pip install unirule
```
## Usage
```bash
unirule -h
```
```plain
usage: unirule [-h] -i {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout} -o
{singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text} [-p]
input_path output_path
positional arguments:
input_path "stdin" or path to the input file
output_path "stdout" or path to the output file
options:
-h, --help show this help message and exit
-i {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout}, --input-type {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout}
type of the input file
-o {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text}, --output-type {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text}
type of the output file
-p, --pedantic mark all warnings as errors
```
## Develop
This project uses [Rye](https://rye.astral.sh/).
```bash
git clone https://github.com/TargetLocked/unirule.git
cd unirule
rye sync
```
For more information, please refer to the manual of Rye.
Raw data
{
"_id": null,
"home_page": null,
"name": "unirule",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "TargetLocked <32962687+TargetLocked@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/df/f9/771cf852fb2fc1c4cc9b0d98e05fd9ff097d08324460156225b51df6f5e6/unirule-0.2.0.tar.gz",
"platform": null,
"description": "# unirule\n\nRule converter for proxy platforms.\n\nunirule supports rules in text formats only. For binary formats, we recommend [MetaCubeX/geo](https://github.com/MetaCubeX/geo).\n\n## Install\n\nunirule requires Python >= 3.10 .\n\n```bash\npip install unirule\n```\n\n## Usage\n\n```bash\nunirule -h\n```\n\n```plain\nusage: unirule [-h] -i {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout} -o\n {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text} [-p]\n input_path output_path\n\npositional arguments:\n input_path \"stdin\" or path to the input file\n output_path \"stdout\" or path to the output file\n\noptions:\n -h, --help show this help message and exit\n -i {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout}, --input-type {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text,adguard-dns,adguard-dns-multiout}\n type of the input file\n -o {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text}, --output-type {singbox,dlc,meta-domain-yaml,meta-domain-text,meta-ipcidr-yaml,meta-ipcidr-text}\n type of the output file\n -p, --pedantic mark all warnings as errors\n```\n\n## Develop\n\nThis project uses [Rye](https://rye.astral.sh/).\n\n```bash\ngit clone https://github.com/TargetLocked/unirule.git\ncd unirule\nrye sync\n```\n\nFor more information, please refer to the manual of Rye.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Rule converter for proxy platforms.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/TargetLocked/unirule",
"Repository": "https://github.com/TargetLocked/unirule"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6880a4642aae276526045ea52a09f6c8740192c31fd93aec879b4401dfa3a4a",
"md5": "2dc8e122065e88ec2cfe5c20b688d2b2",
"sha256": "785bce9f9060533ab11e914ceebfaccaf12b58efd34d4580bb9faec46f464c32"
},
"downloads": -1,
"filename": "unirule-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2dc8e122065e88ec2cfe5c20b688d2b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31886,
"upload_time": "2024-08-25T17:40:03",
"upload_time_iso_8601": "2024-08-25T17:40:03.989707Z",
"url": "https://files.pythonhosted.org/packages/d6/88/0a4642aae276526045ea52a09f6c8740192c31fd93aec879b4401dfa3a4a/unirule-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dff9771cf852fb2fc1c4cc9b0d98e05fd9ff097d08324460156225b51df6f5e6",
"md5": "8e9046649e3fe1609394481f8c0cc91d",
"sha256": "f6ceae9a1f095dd33b9fea10ad9ab4d9d5c105757e85912b7a2304134e0de410"
},
"downloads": -1,
"filename": "unirule-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8e9046649e3fe1609394481f8c0cc91d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20558,
"upload_time": "2024-08-25T17:40:05",
"upload_time_iso_8601": "2024-08-25T17:40:05.861898Z",
"url": "https://files.pythonhosted.org/packages/df/f9/771cf852fb2fc1c4cc9b0d98e05fd9ff097d08324460156225b51df6f5e6/unirule-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 17:40:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TargetLocked",
"github_project": "unirule",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "unirule"
}
