# Code Generator Odin
A flexible source code generator with fixed structure templates.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features
- Generate code snippets for various programming languages.
- Create project templates for quick setup.
- Customize boilerplate code to fit your needs.
## Installation
To install the Code Generator Odin, clone the repository and install the dependencies:
```sh
git clone https://github.com/odin-hoang/code-generator.git
cd code-generator
pip install .
```
For development, you can install the package with testing dependencies:
```sh
pip install -e .[test]
```
## Usage
To generate a code snippet, run the following command:
```sh
generate-code -t path/to/template.json -o path/to/output.py
```
**Arguments**
- `-t`, `--template`: Path to the JSON template file (required).
- `-o`, `--output`: Output file path (defaults to stdout).
- `--indent`: Number of spaces for indentation (default: 4).
## Development
**Running Tests**
```sh
pytest tests/
```
The tests are automatically run on each push and pull request to the main branch using GitHub Actions. See the tests.yml for more details.
# Contributing
We welcome contributions! Please read our contributing guidelines for more details.
# License
This project is licensed under the MIT License. See the LICENSE file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/odin-hoang/code-generator",
"name": "code-generator-odin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "code generator, template, python",
"author": "Khai Hoang",
"author_email": "khaihq@gfigroup.io",
"download_url": "https://files.pythonhosted.org/packages/31/d3/0d14eb8eb94fb7b272860c751d7084f8981b70c33546f44922434afcc968/code_generator_odin-0.1.2.tar.gz",
"platform": null,
"description": "# Code Generator Odin\n\nA flexible source code generator with fixed structure templates.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Development](#development)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Features\n\n- Generate code snippets for various programming languages.\n- Create project templates for quick setup.\n- Customize boilerplate code to fit your needs.\n\n## Installation\n\nTo install the Code Generator Odin, clone the repository and install the dependencies:\n\n```sh\ngit clone https://github.com/odin-hoang/code-generator.git\ncd code-generator\npip install .\n```\n\nFor development, you can install the package with testing dependencies:\n\n```sh\npip install -e .[test]\n```\n\n## Usage\n\nTo generate a code snippet, run the following command:\n\n```sh\ngenerate-code -t path/to/template.json -o path/to/output.py\n```\n\n**Arguments**\n\n- `-t`, `--template`: Path to the JSON template file (required).\n- `-o`, `--output`: Output file path (defaults to stdout).\n- `--indent`: Number of spaces for indentation (default: 4).\n\n## Development\n\n**Running Tests**\n\n```sh\npytest tests/\n```\n\nThe tests are automatically run on each push and pull request to the main branch using GitHub Actions. See the tests.yml for more details.\n\n# Contributing\n\nWe welcome contributions! Please read our contributing guidelines for more details.\n\n# License\n\nThis project is licensed under the MIT License. See the LICENSE file for more information.\n",
"bugtrack_url": null,
"license": null,
"summary": "A flexible source code generator with fixed structure templates",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/odin-hoang/code-generator"
},
"split_keywords": [
"code generator",
" template",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15cffd90ff4c04be134a8935aa16fe159d02542957bbd28bae8277b10f719e42",
"md5": "9614c4f8d2de85795f5f2ceadd03e803",
"sha256": "313e4c8464e236e1454b1cce5b04296b9d0bff8764f68a6c371634d49867bf33"
},
"downloads": -1,
"filename": "code_generator_odin-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9614c4f8d2de85795f5f2ceadd03e803",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4033,
"upload_time": "2024-10-30T08:24:27",
"upload_time_iso_8601": "2024-10-30T08:24:27.702570Z",
"url": "https://files.pythonhosted.org/packages/15/cf/fd90ff4c04be134a8935aa16fe159d02542957bbd28bae8277b10f719e42/code_generator_odin-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31d30d14eb8eb94fb7b272860c751d7084f8981b70c33546f44922434afcc968",
"md5": "9a0701e6c6dafb9e2af0fa9568f9d1dc",
"sha256": "42a0565af26d82bd649eefcc546184b54e7b52e7b330508467c682774d59d239"
},
"downloads": -1,
"filename": "code_generator_odin-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9a0701e6c6dafb9e2af0fa9568f9d1dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3526,
"upload_time": "2024-10-30T08:24:29",
"upload_time_iso_8601": "2024-10-30T08:24:29.091313Z",
"url": "https://files.pythonhosted.org/packages/31/d3/0d14eb8eb94fb7b272860c751d7084f8981b70c33546f44922434afcc968/code_generator_odin-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 08:24:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "odin-hoang",
"github_project": "code-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "code-generator-odin"
}
JSON
