## create_doc
Generate angular project documentation using GPT and dependency-cruiser.
- Free software: MIT license
### Features
- Create documentation for your project using GPT. Analyze html files or other file types and generate a markdown file with the documentation.
- Create module dependency documentation using dependency-cruiser static code analysis.
### Installation
- Install the package with pip:
pip install create_doc
- Define the following environment variables:
OPENAI_API_KEY: Your OpenAI API key
- Install the following tools used by the processors:
- Install dependency-cruiser in the project you want to analyze
npm install dependency-cruiser
- or install dependency-cruiser globally to use it in other projects (it will show some warnings during processing
npm install -g dependency-cruiser
### Usage
- Initialize a project with the following command:
create_doc init
- Check the configuration file `.create_doc.json` created in the root of your project and adjust it to your needs. You can define multiple processors for gpt and dependencies.
- Create documentation for your project the following command:
create_doc gpt-process
- You can also run the specific gpt processors with the following commands:
create_doc gpt-process processor_name
- for example
create_doc gpt-process forms
- Create documentation for your project dependencies with the following command:
create_doc analyze-dependencies
- To run the specific dependency processors use the following commands:
create_doc analyze-dependencies processor_name
### Credits
OpenAI API is used to generate the documentation.
- OpenAI API: https://openai.com/
Dependency-cruiser is used to analyze the dependencies of the project.
- Dependency-cruiser: https://github.com/sverweij/dependency-cruiser
Example angular form from https://github.com/gothinkster/angular-realworld-example-app
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
- Cookiecutter: https://github.com/audreyr/cookiecutter
- `audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
# History
## 0.1.0 (2023-03-25)
* First release on PyPI.
## 0.1.2 (2023-03-27)
* Improved GPT documentation generation.
Raw data
{
"_id": null,
"home_page": "https://github.com/Nomendi6/create_doc",
"name": "create-doc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "create_doc",
"author": "Ivan Vrbov\u010dan",
"author_email": "ivan.vrbovcan@nomendi6.com",
"download_url": "https://files.pythonhosted.org/packages/bc/d4/245f8e296a395c5c9d7c52f9e858a5ef62ceeff0041749b700519e530ee0/create_doc-0.1.6.tar.gz",
"platform": null,
"description": "## create_doc\n\nGenerate angular project documentation using GPT and dependency-cruiser.\n\n- Free software: MIT license\n\n### Features\n\n- Create documentation for your project using GPT. Analyze html files or other file types and generate a markdown file with the documentation.\n\n- Create module dependency documentation using dependency-cruiser static code analysis.\n\n### Installation\n\n- Install the package with pip:\n\n pip install create_doc\n\n- Define the following environment variables:\n\n OPENAI_API_KEY: Your OpenAI API key\n\n- Install the following tools used by the processors:\n - Install dependency-cruiser in the project you want to analyze\n\n\n npm install dependency-cruiser\n\n - or install dependency-cruiser globally to use it in other projects (it will show some warnings during processing\n\n npm install -g dependency-cruiser\n\n\n\n### Usage\n\n- Initialize a project with the following command:\n\n create_doc init\n\n- Check the configuration file `.create_doc.json` created in the root of your project and adjust it to your needs. You can define multiple processors for gpt and dependencies.\n\n- Create documentation for your project the following command:\n\n create_doc gpt-process\n\n- You can also run the specific gpt processors with the following commands:\n\n create_doc gpt-process processor_name\n\n- for example\n\n create_doc gpt-process forms\n\n- Create documentation for your project dependencies with the following command:\n\n create_doc analyze-dependencies\n\n- To run the specific dependency processors use the following commands:\n\n create_doc analyze-dependencies processor_name\n\n### Credits\n\nOpenAI API is used to generate the documentation.\n\n- OpenAI API: https://openai.com/\n\nDependency-cruiser is used to analyze the dependencies of the project.\n\n- Dependency-cruiser: https://github.com/sverweij/dependency-cruiser\n\nExample angular form from https://github.com/gothinkster/angular-realworld-example-app\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n- Cookiecutter: https://github.com/audreyr/cookiecutter\n- `audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n\n# History\n\n## 0.1.0 (2023-03-25)\n\n* First release on PyPI.\n\n## 0.1.2 (2023-03-27)\n\n* Improved GPT documentation generation.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Generate project documentation using GPT.",
"version": "0.1.6",
"split_keywords": [
"create_doc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69c897bacd836222a19d2a04cd2ef0845992c296afbefdd6c37b5fb61c08b28d",
"md5": "2bb5ae8004149bb0685d375aed7c0d25",
"sha256": "63d494d38d8e67d3107aa3f51c46d1900fc4acfc9f6a781cc105e16fd5d0c975"
},
"downloads": -1,
"filename": "create_doc-0.1.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2bb5ae8004149bb0685d375aed7c0d25",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 13619,
"upload_time": "2023-03-31T09:52:13",
"upload_time_iso_8601": "2023-03-31T09:52:13.780823Z",
"url": "https://files.pythonhosted.org/packages/69/c8/97bacd836222a19d2a04cd2ef0845992c296afbefdd6c37b5fb61c08b28d/create_doc-0.1.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bcd4245f8e296a395c5c9d7c52f9e858a5ef62ceeff0041749b700519e530ee0",
"md5": "a7e5fb8c27bab02d2d183ce12b20bb30",
"sha256": "e4b62da56cd08a6dcb93aae50c1f7e0b3c256c36d367226f623ceafc6593f33f"
},
"downloads": -1,
"filename": "create_doc-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "a7e5fb8c27bab02d2d183ce12b20bb30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 88813,
"upload_time": "2023-03-31T09:52:16",
"upload_time_iso_8601": "2023-03-31T09:52:16.184989Z",
"url": "https://files.pythonhosted.org/packages/bc/d4/245f8e296a395c5c9d7c52f9e858a5ef62ceeff0041749b700519e530ee0/create_doc-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-31 09:52:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Nomendi6",
"github_project": "create_doc",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "create-doc"
}
JSON
