semvec/pypi-packages huggingface dataset:
readme-patcher 0.6.0
Generate README files from templates. Allow input from functions calls and cli output.
License: MIT
Requires Python: >=3.8,<4.0

.. image:: http://img.shields.io/pypi/v/readme-patcher.svg
    :target: https://pypi.org/project/readme-patcher
    :alt: This package on the Python Package Index

.. image:: https://github.com/Josef-Friedrich/readme_patcher/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/Josef-Friedrich/readme_patcher/actions/workflows/tests.yml
    :alt: Tests

readme_patcher
==============

Generate README files from templates. Allow input from functions calls and cli
output.

.. code-block:: shell

    cd your-project
    vim README_template.rst
    poetry add --group dev readme-patcher
    poetry shell
    readme-patcher # README.rst

Global objects
--------------

py_project
^^^^^^^^^^

.. code-block:: jinja

    {{ py_project.repository }}

github
^^^^^^

.. code-block:: jinja

    {{ github.name }}
    {{ github.full_name }}
    {{ github.description }}

badge
^^^^^

.. code-block:: jinja

    {{ badge.pypi }}
    {{ badge.github_workflow('tests' 'Tests') }}
    {{ badge.readthedocs }}

Functions
---------

cli: Combined output (stdout and stderr) of command line interfaces (scripts / binaries)

.. code-block:: jinja

    {{ cli('awk --help') }}

func: return values of Python functions

.. code-block:: jinja

    {{ func('os.getcwd') }}

read: read text files

.. code-block:: jinja

    {{ read('code/example.py') | code('python') }}

Filters
-------

code
^^^^

.. code-block:: jinja

    {{ 'print("example")' | code('python') }}

::

    .. code-block:: python

        print("example")

literal
^^^^^^^

.. code-block:: jinja

    {{ func('os.getcwd') | literal }}

::

    ::

        /home/repos/project

heading
^^^^^^^

.. code-block:: jinja

    {{ 'heading 1' | heading(1) }}

    {{ 'heading 2' | heading(2) }}

    {{ 'heading 3' | heading(3) }}

    {{ 'heading 4' | heading(4) }}

::

    heading 1
    =========

    heading 2
    ---------

    heading 3
    ^^^^^^^^^

    heading 4
    """""""""

Examples
--------

.. code-block:: jinja

    {% for command in [
                      'dns-ipv6-prefix.py',
                      'extract-pdftext.py',
                      'find-dupes-by-size.py',
                      'list-files.py',
                      'mac-to-eui64.py',
                      'pdf-compress.py',
                      'image-into-pdf.py'
                      ]
    %}

    ``{{ command }}``

    {{ cli('{} --help'.format(command)) | literal }}
    {% endfor %}

Configuration
-------------

.. code-block:: toml

    [[tool.readme_patcher.file]]
    src = "README_template.rst"
    dest = "README.rst"
    variables = { cwd = "func:os.getcwd", fortune = "cli:fortune --help" }
levitydash 0.1.0b10
A lightweight, desktop native, multi-source, modulear dashboard for macOS, Windows and Linux
License: MIT
Requires Python: >=3.10,<3.11
Keywords: dashboard,desktop,app,weather,dash

<p align="center">
	<p align="center">
   <img width="200" height="200" src="https://github.com/noblecloud/LevityDash/raw/gh-pages/docs/_images/favicons/android-chrome-512x512.png" alt="Logo">
  </p>
	<h1 align="center" color="505050">
		<strong><b>LevityDash</b></strong>
	</h1>
  <p align="center">
  	A lightweight, desktop native, multisource dashboard for macOS, Windows and Linux
  </p>
</p>

![Screenshot](https://user-images.githubusercontent.com/6209052/166817312-8401c7dc-f1c9-47c0-b99d-d24b4280d560.png)

LevityDash aims to be a lightweight, desktop native, multisource dashboard without a required web frontend. The current version only supports PySide2/Qt. However, a key goal of this project is to support multiple frontends and
platforms, including embedded.

*Note: This project is very much in the proof of concept stage – it functions, but it is far from the goal of a lightweight dashboard.*

<p align="right">
<img src="https://img.shields.io/badge/license-MIT-blueviolet">
<img src="https://img.shields.io/badge/Python-3.10-blueviolet">
<img src="https://img.shields.io/badge/aiohttp-3.6-blueviolet">
<img src="https://img.shields.io/badge/PySide2-5.12-blueviolet">

</p>

# Current Features

## Backend

- Plugin system for adding new sources
- Scheduling API pulls
- Data/key maps for automatically parsing ingested data
- Unit library for automatic localization/conversion
- Conditional value updates. i.e. if wind speed is zero do not log the wind direction

### Data Sources

- REST API Pull
- Sockets (UDP, websocket, socket.io)
- BLE Advertisements

### Builtin Plugins

- [Open-Meteo](https://open-meteo.com) [REST]
- [WeatherFlow Tempest](https://tempestwx.com) [REST, UDP, Websocket(incomplete)]
- Govee BLE Thermometers/Hygrometers [[GVH5102](https://www.amazon.com/Govee-Hygrometer-Thermometer-Temperature-Notification/dp/B087313N8F?th=1)]

## Frontend

- Drag and drop dashboard design (This can be a little funky at times)
- YAML based dashboard specifications with support for both absolute and relative size/positioning
- Module grouping
- Editable Margins for text modules
- Resizable graph figures
- Custom, value mapped, gradients for figure items
- Text filters (i.e. lower, title, upper, digit to ordinal, etc.)

## Current Modules

- Realtime single line text with support for showing units and titles and mapping glyphs/emojis to values
- Timeseries Graph
- Customizable Clock
- Moon Phase
- Submodule Group for organizing modules

## Planned Modules

- Gauges [nearly complete]
- Weather Radar
- Multiline Text
- RSS Feeds
- Calendar
- Mini Graphs
- More plot types
web-health-checker 1.3.1
A health checker for a website with a is-healthy route.
License: MIT
Requires Python: >=3.9
Keywords: web utility

# Web Status Checker
A health checker for a website with a is-healthy route.

> This is mostly intended to be used in my projects.

## Usage
It is expected that the server url you are querying will return a "🆗" with a 200 status code for a response. Sending anything else will result in the server signalling an error.

To run the program from CLI the following is the help dialogue:

```
usage: web_health_checker [-h] [--timeout TIMEOUT] url

Health check website

positional arguments:
  url                url to query for status

optional arguments:
  -h, --help          show this help message and exit
  --timeout TIMEOUT   timeout before connection fail
  --allow-unverified  allows for invalid self-signed certificates to be valid
```

Example:

```
python -m web_health_checker http://localhost:8080/is-healthy
```

After the command has been run depending on the state of the server different results will be output. These are shown below. The output will be sent to stdout if there is no error and stderr if there is an error.

| Output                             | Why                                                 | Is Error |
| :--------------------------------- | :-------------------------------------------------- | :------- |
| `🆗`                                | Everything is fine                                  | No       |
| `⛔ missing '🆗' in response`        | The server does not return the expected ok response | Yes      |
| `⛔ http status '<status-code>'`    | The server sent incorrect status code               | Yes      |
| `⛔ url error <reason>`             | A URL error was detected                            | Yes      |
| `⛔ remote closed without response` | The remote server closed the connection             | Yes      |