.. 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 <new_name>
• Modify authorized information at <project_name>/__version__.py

Related Project

• thombashi/python-cli-project-template <https://github.com/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 <project_name>

Usage

:Sample Code: .. code-block:: python

    # Sample code

:Output: .. code-block::

    # Output

Dependencies

• Python 3.8+
• Python package dependencies (automatically installed) <https://github.com/thombashi/python-lib-project-template/network/dependencies>__