[elpa] externals/plz-event-source de99b89df6 21/22: ELPA preparations

[ELPA Syncer]

branch: externals/plz-event-source
commit de99b89df65fce979c2edadf5765e324fa44234a
Author: Roman Scherer <roman@burningswell.com>
Commit: Roman Scherer <roman@burningswell.com>

    ELPA preparations
---
 .elpaignore           |   7 +--
 .gitignore            |   5 +-
 README.org            |  41 ++++--------
 checkout              |   1 -
 plz-event-source.el   |   4 +-
 plz-event-source.info | 170 --------------------------------------------------
 6 files changed, 19 insertions(+), 209 deletions(-)

diff --git a/.elpaignore b/.elpaignore
index 49acf3c1f2..192cbd389d 100644
--- a/.elpaignore
+++ b/.elpaignore
@@ -1,8 +1,5 @@
 .elpaignore
 Makefile
 makem.sh
-NOTES.org
-.github/
-images/
-tests/
-README.info
+.github
+tests
diff --git a/.gitignore b/.gitignore
index e343a998bf..1c51da42d2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,5 @@
 *.elc
-/scratch.el
 .#*
-/sandbox/
 /.sandbox/
-/worktrees/
+/sandbox/
+/scratch.el
diff --git a/README.org b/README.org
index 0d459ae1da..4ea65eebe1 100644
--- a/README.org
+++ b/README.org
@@ -2,10 +2,15 @@
 
 #+PROPERTY: LOGGING nil
 
-# Note: This readme works with the org-make-toc
-# <https://github.com/alphapapa/org-make-toc> package, which
-# automatically updates the table of contents.
+# NOTE: It would be preferable to put these at the bottom of the file under 
the export options heading, but it seems that "TEXINFO_DIR_CATEGORY" only works 
at the top of the file.
+#+EXPORT_FILE_NAME: plz-event-source.texi
+#+TEXINFO_DIR_CATEGORY: Emacs
+#+TEXINFO_DIR_TITLE: Plz Event Source: (plz-event-source)
+#+TEXINFO_DIR_DESC: Event Source extension for plz.el
 
+# Note: This readme works with the org-make-toc 
<https://github.com/alphapapa/org-make-toc> package, which automatically 
updates the table of contents.
+
+[[http://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg]]
 
[[http://elpa.gnu.org/packages/plz-event-source.html][http://elpa.gnu.org/packages/plz-event-source.svg]]
 
[[https://github.com/r0man/plz-event-source/actions/workflows/test.yml][https://github.com/r0man/plz-event-source/actions/workflows/test.yml/badge.svg]]
 
@@ -15,7 +20,7 @@ used in the [[https://github.com/ahyatt/llm][LLM]] library to 
handle server sent
 
 👷🏽 NOTE: This is work in progress. The library is not yet on ELPA.
 
-* Contents                                                         :noexport:
+* Contents :noexport:
 :PROPERTIES:
 :TOC:      :include siblings
 :END:
@@ -97,45 +102,25 @@ to the FSF.  Contributors who wish to do so may contact
 
 GPLv3
 
-* COMMENT Export setup :noexport:
+* COMMENT Export setup                                             :noexport:
 :PROPERTIES:
 :TOC:      :ignore (this descendants)
 :END:
 
-# Copied from org-super-agenda's readme, in which much was borrowed
-# from Org's =org-manual.org=.
+# Copied from org-super-agenda's readme, in which much was borrowed from Org's 
=org-manual.org=.
 
 #+OPTIONS: broken-links:t *:t
 
 ** Info export options
 
-#+TEXINFO_DIR_CATEGORY: Emacs
-#+TEXINFO_DIR_TITLE: Plz Event Source: (plz-event-source)
-#+TEXINFO_DIR_DESC: A plz.el media type to handle Server-Sent Events
-
-# NOTE: We could use these, but that causes a pointless error,
-# "org-compile-file: File "..README.info" wasn't produced...", so we
-# just rename the files in the after-save-hook instead.
-
-# #+TEXINFO_FILENAME: plz-event-source.info
-# #+EXPORT_FILE_NAME: plz-event-source.texi
+# NOTE: These are moved to the top of the file.
 
 ** File-local variables
 
-# NOTE: Setting org-comment-string buffer-locally is a nasty hack to
-# work around GitHub's org-ruby's HTML rendering, which does not
-# respect noexport tags.  The only way to hide this tree from its
-# output is to use the COMMENT keyword, but that prevents Org from
-# processing the export options declared in it.  So since these
-# file-local variables don't affect org-ruby, wet set
-# org-comment-string to an unused keyword, which prevents Org from
-# deleting this tree from the export buffer, which allows it to find
-# the export options in it.  And since org-export does respect the
-# noexport tag, the tree is excluded from the info page.
+# NOTE: Setting org-comment-string buffer-locally is a nasty hack to work 
around GitHub's org-ruby's HTML rendering, which does not respect noexport 
tags.  The only way to hide this tree from its output is to use the COMMENT 
keyword, but that prevents Org from processing the export options declared in 
it.  So since these file-local variables don't affect org-ruby, wet set 
org-comment-string to an unused keyword, which prevents Org from deleting this 
tree from the export buffer, which all [...]
 
 # Local Variables:
 # eval: (require 'org-make-toc)
-# after-save-hook: (lambda nil (when (and (require 'ox-texinfo nil t) 
(org-texinfo-export-to-info)) (delete-file "README.texi") (rename-file 
"README.info" "plz-event-source.info" t)))
 # before-save-hook: org-make-toc
 # org-export-with-properties: ()
 # org-export-with-title: t
diff --git a/checkout b/checkout
index feb2cc277c..c87d806a76 100755
--- a/checkout
+++ b/checkout
@@ -2,7 +2,6 @@
 set -e
 set -o pipefail
 mkdir -p vendor
-wget -q -O vendor/plz.el 
https://raw.githubusercontent.com/r0man/plz.el/process-filter-option/plz.el
 wget -q -O vendor/plz-media-type.el 
https://raw.githubusercontent.com/r0man/plz-media-type/main/plz-media-type.el
 if [[ ! -z "$GITHUB_ENV" ]]; then
     echo "EMACSLOADPATH=vendor:$EMACSLOADPATH" >> $GITHUB_ENV
diff --git a/plz-event-source.el b/plz-event-source.el
index f54ed85a5c..762a511272 100644
--- a/plz-event-source.el
+++ b/plz-event-source.el
@@ -1,4 +1,4 @@
-;;; plz-event-source.el --- Server Sent Event Source -*- lexical-binding: t; 
-*-
+;;; plz-event-source.el --- Plz Event Source -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2019-2023  Free Software Foundation, Inc.
 
@@ -6,7 +6,7 @@
 ;; Maintainer: r0man <roman@burningswell.com>
 ;; URL: https://github.com/r0man/plz-event-source.el
 ;; Version: 0.1-pre
-;; Package-Requires: ((emacs "26.3"))
+;; Package-Requires: ((emacs "26.3") (plz "0.8"))
 ;; Keywords: comm, network, http
 
 ;; This file is part of GNU Emacs.
diff --git a/plz-event-source.info b/plz-event-source.info
deleted file mode 100644
index 1615fa7cff..0000000000
--- a/plz-event-source.info
+++ /dev/null
@@ -1,170 +0,0 @@
-This is README.info, produced by makeinfo version 6.8 from README.texi.
-
-INFO-DIR-SECTION Emacs
-START-INFO-DIR-ENTRY
-* Plz Event Source: (plz-event-source). A plz.el media type to handle 
Server-Sent Events.
-END-INFO-DIR-ENTRY
-
-
-File: README.info,  Node: Top,  Next: Installation,  Up: (dir)
-
-plz-event-source
-****************
-
-http://elpa.gnu.org/packages/plz-event-source.svg
-(http://elpa.gnu.org/packages/plz-event-source.html)
-https://github.com/r0man/plz-event-source/actions/workflows/test.yml/badge.svg
-(https://github.com/r0man/plz-event-source/actions/workflows/test.yml)
-
-   ‘plz-event-source’ provides a plz-media-type
-(https://github.com/r0man/plz-media-type), a parser and an event source
-implementation for the Server Sent Event (SSE)
-(https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events)
-protocol.  It is used in the LLM (https://github.com/ahyatt/llm) library
-to handle server sent events.
-
-   👷🏽 NOTE: This is work in progress.  The library is not yet on ELPA.
-
-* Menu:
-
-* Installation::
-* Usage::
-* Credits::
-* License::
-
-— The Detailed Node Listing —
-
-Installation
-
-* GNU ELPA::
-
-Usage
-
-* Examples::
-
-Credits
-
-* Copyright assignment::
-
-
-
-File: README.info,  Node: Installation,  Next: Usage,  Prev: Top,  Up: Top
-
-1 Installation
-**************
-
-* Menu:
-
-* GNU ELPA::
-
-
-File: README.info,  Node: GNU ELPA,  Up: Installation
-
-1.1 GNU ELPA
-============
-
-‘plz-event-source’ is available in GNU ELPA
-(http://elpa.gnu.org/packages/plz-event-source.html).  It may be
-installed in Emacs using the ‘package-install’ command.
-
-
-File: README.info,  Node: Usage,  Next: Credits,  Prev: Installation,  Up: Top
-
-2 Usage
-*******
-
-This library provides the ‘plz-event-source:text/event-stream’ class,
-which is a media type implementation for server sent events.  It should
-be used with the plz-media-type-request
-(https://github.com/r0man/plz-media-type#usage) function of the
-plz-media-type (https://github.com/r0man/plz-media-type) library.
-
-* Menu:
-
-* Examples::
-
-
-File: README.info,  Node: Examples,  Up: Usage
-
-2.1 Examples
-============
-
-The following example shows how to request chat completions from a large
-language model.
-
-     (plz-media-type-request
-       'post "https://api.openai.com/v1/chat/completions";
-       :as `(media-types ((text/event-stream
-                           . ,(plz-event-source:text/event-stream
-                               :handlers `((open . (lambda (event)
-                                                     (message "open: %s" 
event)))
-                                           (message . (lambda (event)
-                                                        (message "message: %s" 
event)))
-                                           (close . (lambda (event)
-                                                      (message "close: %s" 
event))))))))
-       :body (json-encode
-              '(("model" . "gpt-3.5-turbo")
-                ("messages" . [(("role" . "system")
-                                ("content" . "You are an assistant."))
-                               (("role" . "user")
-                                ("content" . "Hello"))])
-                ("stream" . t)))
-       :headers `(("Authorization" . ,(format "Bearer %s"
-                                              (auth-source-pick-first-password
-                                               :host "api.openai.com"
-                                               :user "plz-event-source")))
-                  ("Content-Type" . "application/json")))
-
-
-File: README.info,  Node: Credits,  Next: License,  Prev: Usage,  Up: Top
-
-3 Credits
-*********
-
-   • Thanks to ahyatt (https://github.com/ahyatt) and alphapapa
-     (https://github.com/alphapapa) for their help and advice.
-
-* Menu:
-
-* Copyright assignment::
-
-
-File: README.info,  Node: Copyright assignment,  Up: Credits
-
-3.1 Copyright assignment
-========================
-
-This package is part of GNU Emacs (https://www.gnu.org/software/emacs/),
-being distributed in GNU ELPA (https://elpa.gnu.org/).  Contributions to
-this project must follow GNU guidelines, which means that, as with other
-parts of Emacs, patches of more than a few lines must be accompanied by
-having assigned copyright for the contribution to the FSF.  Contributors
-who wish to do so may contact emacs-devel@gnu.org <emacs-devel@gnu.org>
-to request the assignment form.
-
-
-File: README.info,  Node: License,  Prev: Credits,  Up: Top
-
-4 License
-*********
-
-GPLv3
-
-
-
-Tag Table:
-Node: Top227
-Node: Installation1200
-Node: GNU ELPA1332
-Node: Usage1590
-Node: Examples2029
-Node: Credits3532
-Node: Copyright assignment3795
-Node: License4379
-
-End Tag Table
-
-
-Local Variables:
-coding: utf-8
-End: