wolfcode

Name	wolfcode JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	None
upload_time	2024-04-10 06:06:32
maintainer	None
docs_url	None
author	Shingo Morimoto
requires_python	<4.0,>=3.11
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # wolfCode
Use `wolfcode`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 `wolfcode` command. 

4. **Usage**:
    See help:
   `$ wolfcode --help`

5. **Configulation**
You can pass your config file with `--config-file` option.
Also, Run `check <subcommand> --show-config-path` to see where the default config file are located and you can change value to the variables like 'lanugage' in the config file.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wolfcode",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Shingo Morimoto",
    "author_email": "shingo@wolfssl.com",
    "download_url": "https://files.pythonhosted.org/packages/9d/a6/00c1a3f866071d8f628f562e3da6498e3e7b3909bfefdf4c46f64e288f45/wolfcode-0.1.0.tar.gz",
    "platform": null,
    "description": "# wolfCode\nUse `wolfcode`command to verify your code follows the wolfSSL coding standards.\n\n## Getting Started\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 `wolfcode` command. \n\n4. **Usage**:\n    See help:\n   `$ wolfcode --help`\n\n5. **Configulation**\nYou can pass your config file with `--config-file` option.\nAlso, Run `check <subcommand> --show-config-path` to see where the default config file are located and you can change value to the variables like 'lanugage' in the config file.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3359838bc0aa969db83932f4b2770404a71e080a64a8c705a3d1d0e29898595",
                "md5": "2e30f32c5ef81e03eeadec75a109489d",
                "sha256": "c9857a49c2dc9ec0aebf0ff8a922bd0eec12883dd32793c1df669555b32e43e6"
            },
            "downloads": -1,
            "filename": "wolfcode-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e30f32c5ef81e03eeadec75a109489d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 15299,
            "upload_time": "2024-04-10T06:06:30",
            "upload_time_iso_8601": "2024-04-10T06:06:30.550453Z",
            "url": "https://files.pythonhosted.org/packages/f3/35/9838bc0aa969db83932f4b2770404a71e080a64a8c705a3d1d0e29898595/wolfcode-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9da600c1a3f866071d8f628f562e3da6498e3e7b3909bfefdf4c46f64e288f45",
                "md5": "fcd838914d8740e4b8bf27fc9fb953ac",
                "sha256": "978241464e5d8aa728c6ef33eb1cd516893ed3b53b7c0c9a6d3bec9e60d3f918"
            },
            "downloads": -1,
            "filename": "wolfcode-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fcd838914d8740e4b8bf27fc9fb953ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 9819,
            "upload_time": "2024-04-10T06:06:32",
            "upload_time_iso_8601": "2024-04-10T06:06:32.001770Z",
            "url": "https://files.pythonhosted.org/packages/9d/a6/00c1a3f866071d8f628f562e3da6498e3e7b3909bfefdf4c46f64e288f45/wolfcode-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-10 06:06:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "wolfcode"
}