| Name | pr-review JSON |
| Version |
0.0.0.1
JSON |
| download |
| home_page | |
| Summary | A tool to check wolfSSL coding standards |
| upload_time | 2024-03-04 01:49:19 |
| maintainer | |
| docs_url | None |
| author | Shingo Morimoto |
| requires_python | >=3.9,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PR-review
Use `check`command to verify your code follows the wolfSSL coding standards.
## Getting Started
1. **Clone the repository**: Clone this repository to your local machine to start working with the scripts.
2. **Install dependencies**: Run `pip3 install .` in the root of this project to install the necessary Python packages listed in `pyproject.toml`.
NOTE: If you are using newer pip, you need to add option: `pip3 install --break-system-packages .`
3. **Export OPENAI_API_KEY ⚙️**:
You must exoport an `OPENAI_API_KEY` in your environment.
Also, you must have an access to the GPT-4 model to call OpenAI API. I recommend to export the key in .zshrc.
### Amazing!
Now you can use the `check` command.
4. **Usage**:
`$ check [FILE]...`
- **example**: Use this script to automate the review of pull requests.`$ check file1 file2 file3`
5. **Configulation**
Run `check --show-config-path` to see where the config file are located and you can change value to the variables like 'lanugage' in the config file.
Raw data
{
"_id": null,
"home_page": "",
"name": "pr-review",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Shingo Morimoto",
"author_email": "shingo@wolfssl.com",
"download_url": "https://files.pythonhosted.org/packages/a3/4a/84663ba81b07bc1374f5fc226c09afe4a306da03a939bf5400cc57be4c12/pr_review-0.0.0.1.tar.gz",
"platform": null,
"description": "# PR-review\nUse `check`command to verify your code follows the wolfSSL coding standards.\n\n## Getting Started\n\n\n1. **Clone the repository**: Clone this repository to your local machine to start working with the scripts.\n\n2. **Install dependencies**: Run `pip3 install .` in the root of this project to install the necessary Python packages listed in `pyproject.toml`.\n\n NOTE: If you are using newer pip, you need to add option: `pip3 install --break-system-packages .`\n\n\n3. **Export OPENAI_API_KEY \u2699\ufe0f**:\n\nYou must exoport an `OPENAI_API_KEY` in your environment.\nAlso, you must have an access to the GPT-4 model to call OpenAI API. I recommend to export the key in .zshrc. \n\n### Amazing! \n\nNow you can use the `check` command. \n\n4. **Usage**:\n `$ check [FILE]...`\n - **example**: Use this script to automate the review of pull requests.`$ check file1 file2 file3`\n\n5. **Configulation**\n\nRun `check --show-config-path` to see where the config file are located and you can change value to the variables like 'lanugage' in the config file.\n",
"bugtrack_url": null,
"license": "",
"summary": "A tool to check wolfSSL coding standards",
"version": "0.0.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e15f80d49c9e4b7a0a438242d1f34ee06358d4b21fd40484fc134c7834716bd",
"md5": "f151b0b7afbd22b212d7c554ccb8de6c",
"sha256": "8f496ec0a5f2f77aa877c4470745ec25dc3dc6f2729532d6bc8877a6731b8161"
},
"downloads": -1,
"filename": "pr_review-0.0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f151b0b7afbd22b212d7c554ccb8de6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 10437,
"upload_time": "2024-03-04T01:49:17",
"upload_time_iso_8601": "2024-03-04T01:49:17.885390Z",
"url": "https://files.pythonhosted.org/packages/3e/15/f80d49c9e4b7a0a438242d1f34ee06358d4b21fd40484fc134c7834716bd/pr_review-0.0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a34a84663ba81b07bc1374f5fc226c09afe4a306da03a939bf5400cc57be4c12",
"md5": "ad3d5336795b9a7a77ece6400704f69f",
"sha256": "d6da8f6f67fc55eee8b3de8a9733b63c3324a311b665ab14a2290afe2a77b987"
},
"downloads": -1,
"filename": "pr_review-0.0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ad3d5336795b9a7a77ece6400704f69f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7993,
"upload_time": "2024-03-04T01:49:19",
"upload_time_iso_8601": "2024-03-04T01:49:19.585313Z",
"url": "https://files.pythonhosted.org/packages/a3/4a/84663ba81b07bc1374f5fc226c09afe4a306da03a939bf5400cc57be4c12/pr_review-0.0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 01:49:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pr-review"
}
