# Kenkun Project
## Overview
Welcome to the Kenkun Project! This project aims to be a scaffolding tool for python web projects.
It is designed to help developers quickly create new projects with a predefined structure and configuration.
The project is currently in development and is not yet ready for production use.
## Features
- Feature 1: Create diferent types of web applications, such as Flask, FastHTML and FastHTML standalone.
- Feature 2: Model driven development, with automatic generation of models, views and controllers.
## Installation
To install the necessary dependencies, run the following command:
```bash
pip install kenkun
```
Once installed. Create a configuration file in the root of your project with the following content, inserting your Github access properties:
```python
# Github access properties
GITHUB_USER=''
GITHUB_TOKEN=''
GITHUB_URL=f''
```
## Usage
To start the project, use the following command:
```bash
kk create -a [project-name]
```
To generate a new model, use the following command:
```bash
kk domain -d [model-name]
```
To generate all: views, controllers and models, use the following command:
```bash
kk all -d [model-name]
```
For detailed usage instructions, refer to the [documentation](https://github.com/sylvioazevedo/kenkun/wiki).
## Contributing
We welcome contributions! Please see our [contributing guidelines](https://github.com/sylvioazevedo/kenkun) for more details.
## License
This project is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).
## Contact
For any questions or feedback, please contact <sylvioazevedo@gmail.com>.
Raw data
{
"_id": null,
"home_page": "https://github.com/sylvioazevedo/kenkun",
"name": "kenkun",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Sylvio Ximenez de Azevedo Neto",
"author_email": "sylvioazevedo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8a/55/e8fd2e3195b01f532ca1da087829bed5d81a6dddda3c5627fbfc76d0f7d9/kenkun-0.1.4.tar.gz",
"platform": null,
"description": "# Kenkun Project\r\n\r\n## Overview\r\nWelcome to the Kenkun Project! This project aims to be a scaffolding tool for python web projects. \r\nIt is designed to help developers quickly create new projects with a predefined structure and configuration.\r\nThe project is currently in development and is not yet ready for production use.\r\n\r\n## Features\r\n- Feature 1: Create diferent types of web applications, such as Flask, FastHTML and FastHTML standalone.\r\n- Feature 2: Model driven development, with automatic generation of models, views and controllers.\r\n\r\n## Installation\r\nTo install the necessary dependencies, run the following command:\r\n```bash\r\npip install kenkun\r\n```\r\n\r\nOnce installed. Create a configuration file in the root of your project with the following content, inserting your Github access properties:\r\n```python\r\n# Github access properties\r\nGITHUB_USER=''\r\nGITHUB_TOKEN=''\r\nGITHUB_URL=f''\r\n```\r\n\r\n## Usage\r\nTo start the project, use the following command:\r\n```bash\r\nkk create -a [project-name]\r\n```\r\n\r\nTo generate a new model, use the following command:\r\n```bash\r\nkk domain -d [model-name]\r\n```\r\n\r\nTo generate all: views, controllers and models, use the following command:\r\n```bash\r\nkk all -d [model-name]\r\n```\r\n\r\nFor detailed usage instructions, refer to the [documentation](https://github.com/sylvioazevedo/kenkun/wiki).\r\n\r\n## Contributing\r\nWe welcome contributions! Please see our [contributing guidelines](https://github.com/sylvioazevedo/kenkun) for more details.\r\n\r\n## License\r\nThis project is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).\r\n\r\n## Contact\r\nFor any questions or feedback, please contact <sylvioazevedo@gmail.com>.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A cli ui to generate projects in python.",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/sylvioazevedo/kenkun"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b155cc80205375fc89374c1fd7c0067c1ffe87fc74c1e02f38de610e36766f1d",
"md5": "d5b8cbcd3fa8916a4608cb4ea409b01b",
"sha256": "5eb2be5d09c7c9db8641454cc089dce4d80e7178334e4e3627ce674e0027c721"
},
"downloads": -1,
"filename": "kenkun-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5b8cbcd3fa8916a4608cb4ea409b01b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 5996,
"upload_time": "2025-01-11T01:32:36",
"upload_time_iso_8601": "2025-01-11T01:32:36.745189Z",
"url": "https://files.pythonhosted.org/packages/b1/55/cc80205375fc89374c1fd7c0067c1ffe87fc74c1e02f38de610e36766f1d/kenkun-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a55e8fd2e3195b01f532ca1da087829bed5d81a6dddda3c5627fbfc76d0f7d9",
"md5": "51a78c13b75a8d9e6e99fb7d61868e02",
"sha256": "f28bf601b0c60874c98c64202b7edc6241cc1e365b0f30e671a7efc6487cf530"
},
"downloads": -1,
"filename": "kenkun-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "51a78c13b75a8d9e6e99fb7d61868e02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 6342,
"upload_time": "2025-01-11T01:32:38",
"upload_time_iso_8601": "2025-01-11T01:32:38.991219Z",
"url": "https://files.pythonhosted.org/packages/8a/55/e8fd2e3195b01f532ca1da087829bed5d81a6dddda3c5627fbfc76d0f7d9/kenkun-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 01:32:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sylvioazevedo",
"github_project": "kenkun",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "kenkun"
}
JSON
