https://github.com/thombashi/python-cli-project-template

A project template for a Python CLI tool with CI configurations
https://github.com/thombashi/python-cli-project-template

cli-template python-template template-project

Last synced: 4 months ago
JSON representation

A project template for a Python CLI tool with CI configurations

• Host: GitHub
• URL: https://github.com/thombashi/python-cli-project-template
• Owner: thombashi
• License: mit
• Created: 2020-05-04T08:09:24.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-01T12:46:46.000Z (almost 2 years ago)
• Last Synced: 2024-05-17T00:01:49.223Z (about 1 year ago)
• Topics: cli-template, python-template, template-project
• Language: Python
• Size: 65.4 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. contents:: **cli_project_name**

   :backlinks: top

   :depth: 2

Python CLI project template: getting started

=========================================================

- Click ``[Use this template]`` button to create a new repository

- Replace ``cli_project_name`` within the repository to an arbitrary name

    - ``./rename_to.sh ``

- Modify authorized information at ``/__version__.py``

If you would like to use `click `__ framework, reaname ``/__main_click__.py`` to ``/__main__.py``

Related Project

---------------------------------------------------------

- `thombashi/python-lib-project-template `__

********************************************************

README

Summary

============================================

.. image:: https://github.com/thombashi/python-cli-project-template/actions/workflows/lint_and_test.yml/badge.svg

    :target: https://github.com/thombashi/python-cli-project-template/actions/workflows/lint_and_test.yml

    :alt: CI status of Linux/macOS/Windows

.. image:: https://github.com/thombashi/python-cli-project-template/actions/workflows/github-code-scanning/codeql/badge.svg

    :target: https://github.com/thombashi/python-cli-project-template/actions/workflows/github-code-scanning/codeql

    :alt: CodeQL

Installation

============================================

::

    pip install 

Usage

============================================

:Sample Code:

    .. code-block:: python

        # Sample code

:Output:

    .. code-block::

        # Output

Dependencies

============================================

- Python 3.7+

- `Python package dependencies (automatically installed) `__