Generate angular project documentation using GPT and dependency-cruiser.
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.
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
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
OpenAI API is used to generate the documentation.
Dependency-cruiser is used to analyze the dependencies of the project.
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.
audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackageFAQs
Generate project documentation using GPT.
We found that create-doc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.