{"id":18402529,"url":"https://github.com/wingkwong/pcsk","last_synced_at":"2026-05-18T15:05:13.356Z","repository":{"id":95978084,"uuid":"223720221","full_name":"wingkwong/pcsk","owner":"wingkwong","description":"📦 Python CLI Starter Kit","archived":false,"fork":false,"pushed_at":"2024-05-01T14:43:55.000Z","size":10,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T03:43:16.987Z","etag":null,"topics":["cli","pcsk","python","python-cli","python-cli-starter-kit","quickstart","starter-kit","template"],"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/wingkwong.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},"funding":{"github":"wingkwong","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2019-11-24T09:28:18.000Z","updated_at":"2023-04-15T15:21:45.000Z","dependencies_parsed_at":"2024-11-06T03:21:24.364Z","dependency_job_id":null,"html_url":"https://github.com/wingkwong/pcsk","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/wingkwong%2Fpcsk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wingkwong%2Fpcsk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wingkwong%2Fpcsk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wingkwong%2Fpcsk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wingkwong","download_url":"https://codeload.github.com/wingkwong/pcsk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248612372,"owners_count":21133288,"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":["cli","pcsk","python","python-cli","python-cli-starter-kit","quickstart","starter-kit","template"],"created_at":"2024-11-06T02:42:44.200Z","updated_at":"2026-05-18T15:05:08.331Z","avatar_url":"https://github.com/wingkwong.png","language":"Python","funding_links":["https://github.com/sponsors/wingkwong"],"categories":[],"sub_categories":[],"readme":"# PCSK - Python CLI Starter Kit\n\nPCSK is a CLI starter kit written in Python. It is designed to help you kickstart your Python CLI project using [click](https://github.com/pallets/click/) and following AWS CLI structure. \n\n## Getting started\n\nUsing PCKS requires Python 3.6 or above. After you clone the project, you need to configure the following.\n\n1. Use your favourite editor to edit ``setup.py``, change the info accordingly. \n2. Rename project name ``pcks`` to ``your_project_name`` and CLI name ``pckscli`` to ``your_cli_name`` \n3. Install the packages by running ``python setup.py install``\n4. Run the CLI using ``your_cli_name``. There are built-in two commands ``your_cli_name command1`` and ``your_cli_name command2``\n\n````\nUsage: pcskcli [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  --version  Show the version and exit.\n  --help     Show this message and exit.\n\nCommands:\n  command1  This is a short help for command1\n  command2  This is a short help for command2\n````\n\n### To start writing your commands\n\n1. Go to ``\u003cyour_project_name\u003e/commands`` and copy the existing example ``command1`` or ``command2``\n2. In the new command folder, modify ``__init__.py`` and ``command.py``\n3. Write your CLI logic in ``command.py`` \n- Update ``HELP_TEXT``\n- Update ``SHORT_HELP``\n- Update the command name in ``@click.command`` and options\n- Add your CLI logic in ``do_cli``\n4. Go to ``\u003cyour_project_name\u003e/cli/command.py``, add the package you just created to ``_COMMAND_PACKAGE``\n5. Test your commands\n\n\n## License \nPCKS is licensed under the MIT license. Check the [LICENSE](https://github.com/wingkwong/pcsk/blob/master/LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwingkwong%2Fpcsk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwingkwong%2Fpcsk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwingkwong%2Fpcsk/lists"}