An open API service indexing awesome lists of open source software.

https://github.com/emcd/lm-scribbles


https://github.com/emcd/lm-scribbles

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
+--------------------------------------------------------------------------+

*******************************************************************************
emcd-lm-scribbles
*******************************************************************************

.. image:: https://github.com/emcd/lm-scribbles/actions/workflows/tester.yaml/badge.svg?branch=master&event=push
:alt: Tests Status
:target: https://github.com/emcd/lm-scribbles/actions/workflows/tester.yaml

.. image:: https://emcd.github.io/lm-scribbles/coverage.svg
:alt: Code Coverage Percentage
:target: https://github.com/emcd/lm-scribbles/actions/workflows/tester.yaml

.. image:: https://img.shields.io/github/license/emcd/lm-scribbles
:alt: Project License
:target: https://github.com/emcd/lm-scribbles/blob/master/LICENSE.txt

.. todo:: Provide project description and key features.

Installation 📦
===============================================================================

Method: Install Executable Script
-------------------------------------------------------------------------------

Install via the `uv `_
``tool`` command:

::

uv tool install emcd-lm-scribbles

or, run directly with `uvx
`_:

::

uvx --from emcd-lm-scribbles lmscribbles

Or, install via `pipx `_:

::

pipx install emcd-lm-scribbles

Method: Install Python Package
-------------------------------------------------------------------------------

Install via `uv `_ ``pip``
command:

::

uv pip install emcd-lm-scribbles

Or, install via ``pip``:

::

pip install emcd-lm-scribbles

.. todo:: Provide usage examples and additional content.

Contribution 🤝
===============================================================================

Contribution to this project is welcome! However, it must follow the `code of
conduct
`_
for the project.

Please file bug reports and feature requests in the `issue tracker
`_ or submit `pull
requests `_ to
improve the source code or documentation.

For development guidance and standards, please see the `development guide
`_.

Additional Indicia
===============================================================================

.. image:: https://img.shields.io/github/last-commit/emcd/lm-scribbles
:alt: GitHub last commit
:target: https://github.com/emcd/lm-scribbles

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json
:alt: Copier
:target: https://github.com/copier-org/copier

.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:alt: Hatch
:target: https://github.com/pypa/hatch

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:alt: pre-commit
:target: https://github.com/pre-commit/pre-commit

.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg
:alt: Pyright
:target: https://microsoft.github.io/pyright

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:alt: Ruff
:target: https://github.com/astral-sh/ruff

Other Projects by This Author 🌟
===============================================================================

* `python-absence `_ (`absence `_ on PyPI)

🕳️ A Python library package which provides a **sentinel for absent values** - a falsey, immutable singleton that represents the absence of a value in contexts where ``None`` or ``False`` may be valid values.
* `python-accretive `_ (`accretive `_ on PyPI)

🌌 A Python library package which provides **accretive data structures** - collections which can grow but never shrink.
* `python-classcore `_ (`classcore `_ on PyPI)

🏭 A Python library package which provides **foundational class factories and decorators** for providing classes with attributes immutability and concealment and other custom behaviors.
* `python-dynadoc `_ (`dynadoc `_ on PyPI)

📝 A Python library package which bridges the gap between **rich annotations** and **automatic documentation generation** with configurable renderers and support for reusable fragments.
* `python-falsifier `_ (`falsifier `_ on PyPI)

🎭 A very simple Python library package which provides a **base class for falsey objects** - objects that evaluate to ``False`` in boolean contexts.
* `python-frigid `_ (`frigid `_ on PyPI)

🔒 A Python library package which provides **immutable data structures** - collections which cannot be modified after creation.
* `python-icecream-truck `_ (`icecream-truck `_ on PyPI)

🍦 **Flavorful Debugging** - A Python library which enhances the powerful and well-known ``icecream`` package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.
* `python-mimeogram `_ (`mimeogram `_ on PyPI)

📨 A command-line tool for **exchanging collections of files with Large Language Models** - bundle multiple files into a single clipboard-ready document while preserving directory structure and metadata... good for code reviews, project sharing, and LLM interactions.