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

A project template for a Python library with CI configurations
https://github.com/thombashi/python-lib-project-template

library-template project-template python-template template-project

Last synced: 3 months ago
JSON representation

A project template for a Python library with CI configurations

• Host: GitHub
• URL: https://github.com/thombashi/python-lib-project-template
• Owner: thombashi
• License: mit
• Created: 2017-11-12T03:10:34.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T13:01:30.000Z (9 months ago)
• Last Synced: 2024-05-17T00:01:49.254Z (8 months ago)
• Topics: library-template, project-template, python-template, template-project
• Language: Python
• Homepage:
• Size: 179 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. contents:: **project_name**

   :backlinks: top

   :depth: 2

Python library project template: getting started

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

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

- Replace ``project_name`` within the repository with an arbitrary name

    - ``./rename_to.sh ``

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

Related Project

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

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

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

README

Summary

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

|CI status| |CodeQL| |coverage|

.. |CI status| image:: https://github.com/thombashi/python-lib-project-template/actions/workflows/ci.yml/badge.svg

    :target: https://github.com/thombashi/python-lib-project-template/actions/workflows/ci.yml

    :alt: CI status of Linux/macOS/Windows

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

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

    :alt: CodeQL

.. |coverage| image:: https://coveralls.io/repos/github/thombashi/python-lib-project-template/badge.svg?branch=main

    :target: https://coveralls.io/github/thombashi/python-lib-project-template?branch=main

    :alt: Test coverage: coveralls

Installation

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

::

    pip install 

Usage

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

:Sample Code:

    .. code-block:: python

        # Sample code

:Output:

    .. code-block::

        # Output

Dependencies

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

- Python 3.8+

- `Python package dependencies (automatically installed) `__