{"id":16610753,"url":"https://github.com/nachokhan/pstruc_example","last_synced_at":"2025-07-31T06:13:32.852Z","repository":{"id":218445103,"uuid":"746419908","full_name":"nachokhan/pstruc_example","owner":"nachokhan","description":"A practical showcase of AI-assisted coding using PStruc and ChatGPT, highlighting iterative development and project optimization across three versions with detailed documentation of changes.","archived":false,"fork":false,"pushed_at":"2024-01-22T02:37:11.000Z","size":914,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-08T18:54:26.514Z","etag":null,"topics":["ai-assisted-development","chatgpt","code-optimization","coding-automation","project-enhancement","pstruc","python","software-documentation"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/pstruc/","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/nachokhan.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-01-22T00:12:55.000Z","updated_at":"2024-10-28T16:24:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"b943187d-93e4-44d4-9e7f-8258e4299f27","html_url":"https://github.com/nachokhan/pstruc_example","commit_stats":null,"previous_names":["nachokhan/pstruc_example"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nachokhan/pstruc_example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nachokhan%2Fpstruc_example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nachokhan%2Fpstruc_example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nachokhan%2Fpstruc_example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nachokhan%2Fpstruc_example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nachokhan","download_url":"https://codeload.github.com/nachokhan/pstruc_example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nachokhan%2Fpstruc_example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267997183,"owners_count":24178251,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ai-assisted-development","chatgpt","code-optimization","coding-automation","project-enhancement","pstruc","python","software-documentation"],"created_at":"2024-10-12T01:32:28.789Z","updated_at":"2025-07-31T06:13:32.823Z","avatar_url":"https://github.com/nachokhan.png","language":"Python","readme":"# PStruc Example Project\n\nThis project demonstrates the PStruc library usage for enhancing a project with ChatGPT's assistance. PStruc creates a `pstruc_example.yaml` file, which, along with specific questions, is provided to ChatGPT. The insights or enhancements suggested by ChatGPT are then used to modify the code.\n\nThe project is split into three versions, each representing a stage of development:\n\n- `version_1`: Initial version with potential code issues and missing elements.\n- `version_2`: Revised code based on ChatGPT's suggestions, improved to adhere to PEP8 guidelines.\n- `version_3`: Further enhancements and feature additions proposed by ChatGPT.\n\nEach version folder contains the project files and a `readme.md` file, detailing the ChatGPT interactions and suggested modifications. The `readme.md` in `version_1` is empty as it's the starting point.\n\n*Note*: Setting up and running the project is optional and mainly for experimentation with ChatGPT enhancements.\n\n## Setup Instructions\n\n### 1. Clone the repository.\n\n```\ngit clone https://github.com/nachokhan/pstruc_example.git\n```\n\n### 2. Create and activate the virtual environment:\n\n```\npython -m venv .env\nsource .env/bin/activate\n```\n\n### 3. Install dependecies.\n\n```\npip install -r requirements.txt\n```\n\n### 4. Run the code \n```\npython main.py\n```\n\n## USing PStruc\nRun the following command to generate the project structure:\n\n```\npstruc -ip \".env\",\".git\",\"*pycache*\",\"*.yml\",\"version_*\",\"readme.md\" -fc \"*.py\" -o pstruc_example -f yaml\n```\n\n### Argument Explanation\n- **-ip**: Ignores specified patterns like `.env`, `.git`, `*pycache*`, `*.yml`, `version_*`, and `readme.md`.\n- **-fc**: Includes the content of Python files (`*.py`).\n- **-o**: Sets the output file's name as `pstruc_example.yaml`.\n- **-f**: Chooses YAML as the output format.\n\nThe command generates a `pstruc_example.yaml` file, representing the project's structure, including Python files' content while excluding the defined patterns.\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnachokhan%2Fpstruc_example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnachokhan%2Fpstruc_example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnachokhan%2Fpstruc_example/lists"}