# gencode – Sporniket's toolbox for generating code
> [WARNING] Please read carefully this note before using this project. It contains important facts.
Content
1. What is **gencode – Sporniket's toolbox for generating code**, and when to use it ?
2. What should you know before using **gencode – Sporniket's toolbox for generating code** ?
3. How to use **gencode – Sporniket's toolbox for generating code** ?
4. Known issues
5. Miscellanous
## 1. What is **gencode – Sporniket's toolbox for generating code**, and when to use it ?
**gencode – Sporniket's toolbox for generating code** is a code generator. For now it can generate a set of blanks cpp files and their header files, with parameters to have proper licence notice, copyright notices and taylored header guards.
### What's new in version 1.0.1
Change entry point from `gncpp` to `gencpp`, as expected by the READMEs.
### What's new in version 1.0.0
Initial release, that can generate blank cpp files and their header files.
* Resolves #1 : [gencpp] generate a blank cpp file and its header
* Resolves #2 : [gencpp] generate a valid copyright notice
* Resolves #3 : [gencpp] generate a valid licence notice
* Resolves #4 : [gencpp] generate a header guard using a library name
* Resolves #5 : [gencpp] use a config file to factor common parameters
### Licence
**gencode – Sporniket's toolbox for generating code** is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
**gencode – Sporniket's toolbox for generating code** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with **gencode – Sporniket's toolbox for generating code**.
If not, see http://www.gnu.org/licenses/ .
## 2. What should you know before using **gencode – Sporniket's toolbox for generating code** ?
> **SECURITY WARNING** : **gencode – Sporniket's toolbox for generating code** is not meant to be installed on a public server.
**gencode – Sporniket's toolbox for generating code** is written in [Python](http://python.org) language, version 3.9 or above, and consists of :
* [gencpp](./README-gencpp.md) : the generator of CPP code.
> Do not use **gencode – Sporniket's toolbox for generating code** if this project is not suitable for your project
## 3. How to use **gencode – Sporniket's toolbox for generating code** ?
### Requirements
Python 3.9 or later versions, `pip3` and `pdm` are required.
### From source
To get the latest available code, one must clone the git repository, build and install to the maven local repository.
git clone https://github.com/gencode.git
cd gencode
pdm sync
pdm build
sudo pip3 install dist/gencode-by-sporniket-<version>-py3-none-any.whl
### From Pypi
Add any of the following dependencies that are appropriate to your project.
```
sudo pip3 install gencode-by-sporniket
```
### Documentation
* [User manual of `gencpp`](./README-gencpp.md)
* [User manual of `gencpp blank`](./README-gencpp--blank.md)
## 4. Known issues
See the [project issues](https://github.com/gencode/issues) page.
## 5. Miscellanous
### Report issues
Use the [project issues](https://github.com/gencode/issues) page.
Raw data
{
"_id": null,
"home_page": null,
"name": "gencode-by-sporniket",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "code generator",
"author": null,
"author_email": "Sporniket <sporniket.studio@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/0b/85ceb79adbe9f26e45a57a992e243b85dfff24facaf30d0a8fd0a6ebf3a7/gencode_by_sporniket-1.0.1.tar.gz",
"platform": null,
"description": "# gencode \u2013 Sporniket's toolbox for generating code\n\n\n\n\n\n> [WARNING] Please read carefully this note before using this project. It contains important facts.\n\nContent\n\n1. What is **gencode \u2013 Sporniket's toolbox for generating code**, and when to use it ?\n2. What should you know before using **gencode \u2013 Sporniket's toolbox for generating code** ?\n3. How to use **gencode \u2013 Sporniket's toolbox for generating code** ?\n4. Known issues\n5. Miscellanous\n\n## 1. What is **gencode \u2013 Sporniket's toolbox for generating code**, and when to use it ?\n\n**gencode \u2013 Sporniket's toolbox for generating code** is a code generator. For now it can generate a set of blanks cpp files and their header files, with parameters to have proper licence notice, copyright notices and taylored header guards.\n\n### What's new in version 1.0.1\n\nChange entry point from `gncpp` to `gencpp`, as expected by the READMEs. \n\n### What's new in version 1.0.0\n\nInitial release, that can generate blank cpp files and their header files.\n\n* Resolves #1 :\u202f[gencpp] generate a blank cpp file and its header\n* Resolves #2 : [gencpp] generate a valid copyright notice\n* Resolves #3 : [gencpp] generate a valid licence notice\n* Resolves #4 :\u202f[gencpp] generate a header guard using a library name\n* Resolves #5 : [gencpp] use a config file to factor common parameters\n\n\n### Licence\n **gencode \u2013 Sporniket's toolbox for generating code** is free software: you can redistribute it and/or modify it under the terms of the\n GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your\n option) any later version.\n\n **gencode \u2013 Sporniket's toolbox for generating code** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\n even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for\n more details.\n\n You should have received a copy of the GNU General Public License along with **gencode \u2013 Sporniket's toolbox for generating code**.\n If not, see http://www.gnu.org/licenses/ .\n\n\n## 2. What should you know before using **gencode \u2013 Sporniket's toolbox for generating code** ?\n\n> **SECURITY WARNING** :\u00a0**gencode \u2013 Sporniket's toolbox for generating code** is not meant to be installed on a public server.\n\n**gencode \u2013 Sporniket's toolbox for generating code** is written in [Python](http://python.org) language, version 3.9 or above, and consists of :\n\n* [gencpp](./README-gencpp.md) : the generator of CPP code.\n\n> Do not use **gencode \u2013 Sporniket's toolbox for generating code** if this project is not suitable for your project\n\n## 3. How to use **gencode \u2013 Sporniket's toolbox for generating code** ?\n\n### Requirements\n\nPython 3.9 or later versions, `pip3` and `pdm` are required.\n\n### From source\n\nTo get the latest available code, one must clone the git repository, build and install to the maven local repository.\n\n\tgit clone https://github.com/gencode.git\n\tcd gencode\n\tpdm sync\n\tpdm build\n sudo pip3 install dist/gencode-by-sporniket-<version>-py3-none-any.whl\n\n### From Pypi\nAdd any of the following dependencies that are appropriate to your project.\n\n```\nsudo pip3 install gencode-by-sporniket\n```\n\n### Documentation\n\n* [User manual of `gencpp`](./README-gencpp.md) \n * [User manual of `gencpp blank`](./README-gencpp--blank.md)\n\n## 4. Known issues\nSee the [project issues](https://github.com/gencode/issues) page.\n\n## 5. Miscellanous\n\n### Report issues\nUse the [project issues](https://github.com/gencode/issues) page.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Sporniket's toolbox for generating code",
"version": "1.0.1",
"project_urls": {
"bug-tracker": "https://github.com/sporniket/gencode/issues",
"homepage": "https://github.com/sporniket/gencode",
"repository": "https://github.com/sporniket/gencode"
},
"split_keywords": [
"code",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b38a5c1ab02fd2442739321334fbb0e8387c8a884ef9dfd58528c5b1269c2abd",
"md5": "b1a3b33ca7c91671d7bee92f69cefb22",
"sha256": "b2b34c1a18056f9cada900b476a7a0c61e64b663dc9a459538ac999ec6ffa406"
},
"downloads": -1,
"filename": "gencode_by_sporniket-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1a3b33ca7c91671d7bee92f69cefb22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 30266,
"upload_time": "2024-10-27T14:37:35",
"upload_time_iso_8601": "2024-10-27T14:37:35.083173Z",
"url": "https://files.pythonhosted.org/packages/b3/8a/5c1ab02fd2442739321334fbb0e8387c8a884ef9dfd58528c5b1269c2abd/gencode_by_sporniket-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f0b85ceb79adbe9f26e45a57a992e243b85dfff24facaf30d0a8fd0a6ebf3a7",
"md5": "92197167d1f3677f994c6e352ee6e966",
"sha256": "ad53433437002bd64accad0a7f8dd404d47b64d4f13ff9b0ca16a3a057ff3bd0"
},
"downloads": -1,
"filename": "gencode_by_sporniket-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "92197167d1f3677f994c6e352ee6e966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 24846,
"upload_time": "2024-10-27T14:37:36",
"upload_time_iso_8601": "2024-10-27T14:37:36.736003Z",
"url": "https://files.pythonhosted.org/packages/4f/0b/85ceb79adbe9f26e45a57a992e243b85dfff24facaf30d0a8fd0a6ebf3a7/gencode_by_sporniket-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 14:37:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sporniket",
"github_project": "gencode",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gencode-by-sporniket"
}
JSON
