{"id":21031292,"url":"https://github.com/workable/g3","last_synced_at":"2025-05-15T11:33:25.358Z","repository":{"id":182307167,"uuid":"665881294","full_name":"Workable/g3","owner":"Workable","description":"All-in-one CLI to commit your work to Github","archived":false,"fork":false,"pushed_at":"2024-08-16T09:14:36.000Z","size":898,"stargazers_count":18,"open_issues_count":9,"forks_count":1,"subscribers_count":28,"default_branch":"main","last_synced_at":"2024-08-16T10:24:26.775Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Workable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://www.paypal.me/workableteamg"]}},"created_at":"2023-07-13T07:58:23.000Z","updated_at":"2024-08-16T10:24:29.770Z","dependencies_parsed_at":null,"dependency_job_id":"f3aaedaa-9430-4dbf-a4c1-19d09cbd3ea8","html_url":"https://github.com/Workable/g3","commit_stats":null,"previous_names":["workable/g","workable/g3"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fg3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fg3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fg3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fg3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Workable","download_url":"https://codeload.github.com/Workable/g3/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225349138,"owners_count":17460315,"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-19T12:27:06.439Z","updated_at":"2024-11-19T12:27:07.100Z","avatar_url":"https://github.com/Workable.png","language":"Python","funding_links":["https://www.paypal.me/workableteamg"],"categories":[],"sub_categories":[],"readme":"# G3\nAll-in-one CLI to commit your work to Github [[Presentation](https://docs.google.com/presentation/d/1BZN4cfeGYR9U4UjXF6wH_-x9l8DwGOgJRZr7UDKXiMQ/), [Design](https://docs.google.com/document/d/1b3SkLVnrB_P-lYsD2Kv-fO-oUHciovQbTQbKsNswHtA)]\n\n[![Watch the video](docs/g.png)](https://youtu.be/dTKCxIoPC54)\n\n## Install\n```bash\npip install g3\n```\n\n#### Alias\n\nYou can, optionally, create the `alias g=g3` so that you execute simply `g commit` and `g pr`.\n\n## Configuration\n\n```bash\ng3 configure\n```\n\nYou will be asked to enter:\n- your Github token \n- your open-ai key\n- the openai model you want to use\n- the temperature which will be used to generate the commit messages and PR descriptions\n- the openai api version\n- the tone which will be used in the commit messages and PR descriptions\n- the commit message max characters\n- the PR description max words\n\n\n## Usage\n\n### Commit\n\n```bash\ng3 commit\n```\n\n#### Options:\n- --tone: The tone to use\n- --jira: The jira ticket(s) to reference\n- --include: A phrase you want to include\n- --edit: The hash of the commit you want to rephrase\n\n### PR\n\n```bash\ng3 pr\n```\n\n#### Options:\n- --tone: The tone to use\n- --jira: The jira ticket(s) to reference\n- --include: A phrase you want to include\n- --edit: The number of the PR you want to rephrase\n\n## Development\n\nThe project requires `Python 3.11` and [Poetry](https://python-poetry.org/docs/#installation) for dependency management. \n\nOptionally configure poetry to create the virtual environment within the project as follows:\n```shell script\npoetry config virtualenvs.in-project true\n```\n\n### Build\n\nNow install the project, along with its development dependencies, in a local virtual environment as follows:\n\n```shell\npoetry install\n```\nYou may enable the virtual environment, so that you run modules without the `poetry run` prefix, as follows:\n```\nsource `poetry env info -p`/bin/activate\n```\nor simply as follows:\n```\npoetry shell\n```\n\n### Contribution\n\nYou are expected to enable pre-commit hooks so that you get your code auto-sanitized before being committed.\n* mypy:   Static type checker of variables and functions based on [PEP 484](https://peps.python.org/pep-0484/) \n* isort:  Optimizes imports\n* black:  Opinionated code formatter based on [PEP 8](https://peps.python.org/pep-0008/) \n* flake8: Improves code style and quality based on [PEP 8](https://peps.python.org/pep-0008/)\n\nInstall pre-commit before starting to contribute to the project as follows:\n```\npre-commit install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkable%2Fg3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkable%2Fg3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkable%2Fg3/lists"}