click-app

Name	click-app JSON
Version	0.1.5 JSON
	download
home_page	https://github.com/chuangtc/click-template-cli
Summary	A template of Click application CLI
upload_time	2024-03-31 08:10:26
maintainer	None
docs_url	None
author	Jason Chuang
requires_python	>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # click_app (template-cli)

Leveraging click python package to create cli tool template

A sample code of using click package for running command line tool

## For general users to run the program with pip install

```bash
pip3 install click-app
click_app --name=Jason
```

## For developers to develop features or fix bugs on github

<https://github.com/chuangtc/click-template-cli>

### Installation for development

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip setuptools wheel poetry
pip install click
pip install -e .
pip install pytest
pytest
```

### Usage

```bash
click_app --help
click_app --name=Jason
```

```bash
pip3 install --upgrade build
python3 -m build
```

### After running it, deactivate the .venv

```bash
deactivate
```

## Packaging and uploading to PyPI

### Manual way (For the test.pypi purpose, it's ok)

<https://packaging.python.org/en/latest/tutorials/packaging-projects/>

### Github action

<https://dev.to/iamtekson/publish-package-to-pypi-and-release-new-version-using-github-actions-108k>

Some minor changes, please checkout my .github/workflows

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/chuangtc/click-template-cli",
    "name": "click-app",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jason Chuang",
    "author_email": "chuangtcee@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ba/66/14bfa596eb00aed622b3c73bbffe71e4ea6c862e7ab81a125efd7b288036/click_app-0.1.5.tar.gz",
    "platform": null,
    "description": "# click_app (template-cli)\n\nLeveraging click python package to create cli tool template\n\nA sample code of using click package for running command line tool\n\n## For general users to run the program with pip install\n\n```bash\npip3 install click-app\nclick_app --name=Jason\n```\n\n## For developers to develop features or fix bugs on github\n\n<https://github.com/chuangtc/click-template-cli>\n\n### Installation for development\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install --upgrade pip setuptools wheel poetry\npip install click\npip install -e .\npip install pytest\npytest\n```\n\n### Usage\n\n```bash\nclick_app --help\nclick_app --name=Jason\n```\n\n```bash\npip3 install --upgrade build\npython3 -m build\n```\n\n### After running it, deactivate the .venv\n\n```bash\ndeactivate\n```\n\n## Packaging and uploading to PyPI\n\n### Manual way (For the test.pypi purpose, it's ok)\n\n<https://packaging.python.org/en/latest/tutorials/packaging-projects/>\n\n### Github action\n\n<https://dev.to/iamtekson/publish-package-to-pypi-and-release-new-version-using-github-actions-108k>\n\nSome minor changes, please checkout my .github/workflows\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A template of Click application CLI",
    "version": "0.1.5",
    "project_urls": {
        "Homepage": "https://github.com/chuangtc/click-template-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "344010577425e81d29fab6e11f36badfebef868f3b13bc4871905d5823f795b6",
                "md5": "c4adc7bf183b7ee0d8df76ae8a6f1e2d",
                "sha256": "e4d2f9d36c21e8f7fcdcbf3c05292ff2a9aaeed2238664746674904d41f5c556"
            },
            "downloads": -1,
            "filename": "click_app-0.1.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c4adc7bf183b7ee0d8df76ae8a6f1e2d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 3790,
            "upload_time": "2024-03-31T08:10:25",
            "upload_time_iso_8601": "2024-03-31T08:10:25.524702Z",
            "url": "https://files.pythonhosted.org/packages/34/40/10577425e81d29fab6e11f36badfebef868f3b13bc4871905d5823f795b6/click_app-0.1.5-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba6614bfa596eb00aed622b3c73bbffe71e4ea6c862e7ab81a125efd7b288036",
                "md5": "ab26c0cf7e2d99de5e5fcb6e275678d2",
                "sha256": "b5c257a408f359a347d11d119b3d732671d0fe36be7e11b393d40d5b57594220"
            },
            "downloads": -1,
            "filename": "click_app-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "ab26c0cf7e2d99de5e5fcb6e275678d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3370,
            "upload_time": "2024-03-31T08:10:26",
            "upload_time_iso_8601": "2024-03-31T08:10:26.934907Z",
            "url": "https://files.pythonhosted.org/packages/ba/66/14bfa596eb00aed622b3c73bbffe71e4ea6c862e7ab81a125efd7b288036/click_app-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-31 08:10:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "chuangtc",
    "github_project": "click-template-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "click-app"
}