{"id":24989014,"url":"https://github.com/engineervix/create-project-list","last_synced_at":"2025-03-29T11:29:45.852Z","repository":{"id":38834176,"uuid":"506732670","full_name":"engineervix/create-project-list","owner":"engineervix","description":"a little python script that generates a list of projects for a given GitHub organisation, and saves this information as a table in a .docx document","archived":false,"fork":false,"pushed_at":"2025-03-25T13:40:30.000Z","size":72,"stargazers_count":0,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T14:39:02.975Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineervix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-06-23T17:29:58.000Z","updated_at":"2025-02-08T22:37:37.000Z","dependencies_parsed_at":"2023-11-18T04:27:29.163Z","dependency_job_id":"f96de63a-6aac-4f19-8c04-13a5030e15b9","html_url":"https://github.com/engineervix/create-project-list","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcreate-project-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcreate-project-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcreate-project-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fcreate-project-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineervix","download_url":"https://codeload.github.com/engineervix/create-project-list/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246177893,"owners_count":20736045,"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":"2025-02-04T12:11:49.090Z","updated_at":"2025-03-29T11:29:45.827Z","avatar_url":"https://github.com/engineervix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# create-project-list\n\n[![Continuous Integration](https://github.com/engineervix/create-project-list/actions/workflows/main.yml/badge.svg)](https://github.com/engineervix/create-project-list/actions/workflows/main.yml)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n**Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*\n\n- [About](#about)\n- [Dependencies](#dependencies)\n- [Usage](#usage)\n  - [First things first](#first-things-first)\n  - [Run the script](#run-the-script)\n- [Customize](#customize)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## About\n\nThis is a little python script that generates a list of projects for a given GitHub organisation, and saves this information as a table in a **.docx** document\n\nThe table is structured as follows:\n\n| No. | Name | Description | Language | Stars | Forks | Last updated | Has `setup.py` ? |\n| --- | ---- | ----------- | -------- | ----- | ----- | ------------ | ---------------- |\n| 1   |      |             |          |       |       |              |                  |\n| 2   |      |             |          |       |       |              |                  |\n| 3   |      |             |          |       |       |              |                  |\n| ... |      |             |          |       |       |              |                  |\n\n## Dependencies\n\n- [PyGithub](https://github.com/PyGithub/PyGithub) -- a Python library to access the [GitHub REST API](https://docs.github.com/en/rest).\n- [python-dotenv](https://github.com/theskumar/python-dotenv) -- Reads key-value pairs from a .env file and can set them as environment variables\n- [docxtpl](https://github.com/elapouya/python-docx-template) -- Use a **.docx** document as a [Jinja2](https://jinja.palletsprojects.com) template\n\n## Usage\n\n### First things first\n\n- Clone the repo, create a virtual environment and install the dependencies (`pip install -r requirements.txt`).\n- Create a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), and save it in a `.env` file as `GITHUB_ACCESS_TOKEN=....`. You can make a copy of the provided `.env.sample`:\n\n```bash\ncp -v .env.sample .env\n```\n\n### Run the script\n\nMake it executable:\n\n```bash\nchmod +x ./create_project_list.py\n```\n\nSimply pass the organization name to the script:\n\n```bash\n./create_project_list.py -o [organization]\n```\n\nor\n\n```bash\n./create_project_list.py --org [organization]\n```\n\n## Customize\n\nIf you want additional info for each repo, feel free to customize the script as well as the [template](templates/base_template.docx) to your liking.\n\nPlease refer to the [PyGithub docs](https://pygithub.readthedocs.io/en/latest/) for more info. I also created a text file in the **docs** directory to serve as quick reference for methods/properties available for a repo instance, fir example, `repo.html_url` for a repo's URL.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fcreate-project-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineervix%2Fcreate-project-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fcreate-project-list/lists"}