{"id":21259465,"url":"https://github.com/pmcode9992/documentationassistant","last_synced_at":"2025-03-15T06:42:21.249Z","repository":{"id":247241810,"uuid":"816654455","full_name":"pmcode9992/DocumentationAssistant","owner":"pmcode9992","description":" Documentation Assistant automates technical project documentation using GPT-3.5 Turbo, ensuring comprehensive and accurate records. ","archived":false,"fork":false,"pushed_at":"2024-09-03T10:03:05.000Z","size":120987,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T21:46:54.463Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pmcode9992.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-18T06:51:57.000Z","updated_at":"2024-09-03T10:03:09.000Z","dependencies_parsed_at":"2024-07-07T16:04:58.039Z","dependency_job_id":"f79b3ede-d4de-4f16-9ed6-629e0cfb734a","html_url":"https://github.com/pmcode9992/DocumentationAssistant","commit_stats":null,"previous_names":["pmcode9992/documentationassistant"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmcode9992%2FDocumentationAssistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmcode9992%2FDocumentationAssistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmcode9992%2FDocumentationAssistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmcode9992%2FDocumentationAssistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmcode9992","download_url":"https://codeload.github.com/pmcode9992/DocumentationAssistant/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243695514,"owners_count":20332626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T04:14:12.185Z","updated_at":"2025-03-15T06:42:21.219Z","avatar_url":"https://github.com/pmcode9992.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Assistant\n\n\n## Getting Started\n\nFollow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nEnsure you have the following installed:\n- Python 3.x\n- pip\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```sh\n   git clone https://github.com/pmcode9992/DocumentationAssistant\n   cd DocumentationAssistant\n   ```\n\n2. **Install the required packages:**\n\n   ```sh\n   pip install -r requirements.txt\n   ```\n\n3. **Set up the environment variables:**\n\n   Create a `.env` file in the root directory of the project with the following content:\n\n   ```env\n   contextWindow=16000\n   SingleSession_APIKEY=your_openai_api_key\n   ```\n\n### Running the Application\n\nTo run the application, use the following command:\n\n```sh\nstreamlit run main.py\n```\n\n## Usage\n\ncreate the file structure, when satisfied with the file structure generated (ensure you remove build folders like node_modules, virtual environments etc\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmcode9992%2Fdocumentationassistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmcode9992%2Fdocumentationassistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmcode9992%2Fdocumentationassistant/lists"}