plone-client 1.0.0a1__tar.gz

plone_client-1.0.0a1/.env.example

@@ -0,0 +1,25 @@
+# Connection settings read by PloneClient.from_env() and by the command line
+# when no profile is selected. Profiles (plone-client profile add) are the
+# better choice on a workstation: their secrets live in the system keyring.
+
+PLONE_CLIENT_URL=http://localhost:8080/Plone
+PLONE_CLIENT_USERNAME=admin
+PLONE_CLIENT_PASSWORD=admin
+
+# basic (default) or jwt
+# PLONE_CLIENT_AUTH_METHOD=basic
+
+# A JWT issued beforehand, instead of the username and password
+# PLONE_CLIENT_TOKEN=
+
+# Seconds to wait for the site (default: 30)
+# PLONE_CLIENT_TIMEOUT=30
+
+# Set to false to skip TLS verification (local development only)
+# PLONE_CLIENT_VERIFY=true
+
+# Refuse any request that could change the site
+# PLONE_CLIENT_READ_ONLY=false
+
+# Use a profile instead of the variables above
+# PLONE_CLIENT_PROFILE=local

plone_client-1.0.0a1/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+.env
+.coverage
+htmlcov/
+docs/_build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.log
+.venv
+
+# Local Claude context (not for sharing)
+.claude/CLAUDE.local.md

plone_client-1.0.0a1/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-added-large-files
+        args: ["--maxkb=500"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.2
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  # Type checking needs the project's dependencies, so it runs with
+  # 'make lint' instead of an isolated pre-commit environment.

plone_client-1.0.0a1/.vale.ini

@@ -0,0 +1,12 @@
+StylesPath = docs/_styles
+
+MinAlertLevel = suggestion
+
+Vocab = Base,Plone
+
+Packages = Microsoft
+
+[*]
+BasedOnStyles = Vale, Microsoft
+Microsoft.Contractions = suggestion
+Microsoft.Units = suggestion

plone_client-1.0.0a1/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+<!--
+   You should *NOT* be adding new change log entries to this file.
+   You should create a file in the news directory instead.
+   For helpful instructions, please see:
+   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
+-->
+
+<!-- towncrier release notes start -->
+
+## 1.0.0a1 (2026-10-27)
+
+
+### Breaking changes:
+
+- Rewrote the client on `httpx`: one `PloneClient` per site, with the managers as attributes and paths, site URLs, `uid:<UID>` and `resolveuid` links accepted wherever an item is expected. `AsyncPloneClient`, `PloneClientConfig` and the methods for services that `plone.restapi` does not provide were removed, and Python 3.11 is now the minimum. @ericof 
+
+
+### New features:
+
+- Added `plone_client.operations`, tasks that send several requests in the right order: create an item with files and images inside it and set its lead image, create a page from Markdown or HTML, upload a local folder keeping its structure, and copy or move items with a report. Each operation honors `dry_run` and `read_only`, returns every request it sent, and raises `PloneOperationError` with what was already created when it stops part way. The commands `create-page`, `create-with-files`, and `upload-tree` run them from the command line. @ericof [#9](https://github.com/plone/plone-client/issues/9)
+- Added an MCP server, `plone-client mcp`, in the new `mcp` extra: it serves the selected profile over standard input and output, or several sites at once with `--site`, `--group`, or `--all`, offering the everyday reads, the high-level operations, and one tool for any other `plone.restapi` service; changes to read-only profiles are refused. Profiles can now be gathered into named groups in the configuration file, managed with `plone-client profile groups`, `group-set`, and `group-remove`. @ericof [#9](https://github.com/plone/plone-client/issues/9)
+- Added `blocks.block`, `blocks.container`, `blocks.grid`, and `blocks.teaser`, to build blocks of any type, including add-on blocks and blocks that hold others, such as a grid of four teasers. `blocks.text` now builds its paragraph with `collective.html2blocks` when the `markdown` extra is installed, and collapses runs of whitespace either way. @ericof [#9](https://github.com/plone/plone-client/issues/9)
+- Added `client.block_types` and the `block-types` command, which list the blocks of a Volto site and describe their data from the `@blocks-schema` service of the Volto server, reached through the new `frontend_url` setting. Sites without that service get the documentation of Volto's core blocks instead. The new `markdown` extra converts Markdown and HTML to blocks with `collective.html2blocks`, on Python 3.12 or later. @ericof [#9](https://github.com/plone/plone-client/issues/9)
+- Added `plone_client.blocks`, helpers to build Volto blocks and to walk them and their links. @ericof 
+- Added `read_only` and `dry_run` modes to `PloneClient`, so a script can refuse or preview every change it would make to a site. @ericof 
+- Added an agent skill that teaches coding agents such as Claude Code to work with Plone sites through the command line, installed with `plone-client skill install`. @ericof 
+- Added named connection profiles to work with several sites, with passwords kept in the operating system keyring, an environment variable or a command such as a password manager, read-only profiles, a `.plone-client.toml` file that selects the profile of a project, and timeout, retry, and TLS settings per profile or shared by all of them, including a custom CA bundle. @ericof 
+- Added the `plone-client` command line, installed with the `cli` extra: read, search, create, change, publish, move, upload and download content, and manage users, groups, the registry and aliases, with JSON output and exit codes meant for scripts and agents. @ericof 
+- Grouped the command line help into panels: commands that read, change, or upload content, site administration, advanced requests, and configuration; each command group splits its subcommands into Browse and Write panels. In a terminal the panels are drawn as boxes; when the output goes to a pipe or a file, as for coding agents, the help is plain text with the same groups. @ericof 
+
+
+### Bug fixes:
+
+- Fixed the requests for copying, moving and ordering content, changing the registry, group membership, undoing transactions and uploading files with TUS, which did not match what `plone.restapi` expects. @ericof 
+
+
+### Internal:
+
+- Added a `make release` command that releases the package with zest.releaser and publishes it with uv. @ericof 
+- Licensed the package under the GPLv2, like Plone. @ericof 
+- Moved continuous integration and linting to `uv` and `make` targets, and added the towncrier change log check and Dependabot. @ericof 
+- Updated locked dependencies with security fixes: anyio, certifi, idna, Pygments, requests, soupsieve, and urllib3. @ericof 
+
+
+### Documentation:
+
+- Documented the MCP server, the high-level operations, and the block types: how to connect an assistant, how to create content in one step, how to build any block, a reference of the MCP tools, and an explanation of when to use the MCP server, the command line, or the agent skill. @ericof [#9](https://github.com/plone/plone-client/issues/9)
+- Fixed the links to the `plone.restapi` documentation. @ericof 
+- Rewrote the documentation following the Plone documentation style and the Diátaxis framework, with the Plone Sphinx theme: tutorials, how-to guides with runnable examples, reference including a compatibility grid with Plone and `plone.restapi` versions and a map to the functions of `@plone/client`, and explanation. @ericof 
+
+
+### Tests
+
+- Added unit tests that check every request against the `plone.restapi` documentation, and integration tests against Plone 6.0, 6.1, and 6.2 in Docker. @ericof 
+- Fixed the agent skill tests on Windows, where paths use backslashes and the home directory comes from `USERPROFILE`. @ericof

plone_client-1.0.0a1/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to plone-client
+
+Thank you for helping.
+plone-client follows the [Plone contributing guidelines](https://6.docs.plone.org/contributing/index.html).
+
+## Set up
+
+You need [uv](https://docs.astral.sh/uv/), and Docker for the integration tests.
+
+```shell
+git clone https://github.com/plone/plone-client.git
+cd plone-client
+make install
+```
+
+## Check your change
+
+```shell
+make format             # format the code
+make lint               # ruff, mypy and pyroma; changes nothing
+make test               # unit tests
+make test-coverage      # unit tests with a coverage report
+make test-integration   # integration tests against plone/plone-backend in Docker
+make docs               # build the documentation; warnings are errors
+make docs-vale          # check the documentation's style with Vale
+make docs-livehtml      # rebuild the documentation as you edit it
+```
+
+Unit tests never touch the network.
+They talk to `tests.FakeSite`, an in-memory site behind an httpx `MockTransport`, and the command line tests use `typer.testing.CliRunner` with the same fake site.
+
+Integration tests start `plone/plone-backend` with pytest-docker.
+Pick another image with `PLONE_IMAGE`.
+
+```shell
+PLONE_IMAGE=plone/plone-backend:6.0 make test-integration
+```
+
+## Add a service
+
+1. Add the methods to the manager for the service in `src/plone_client/managers/`, or create a manager that extends `BaseManager`, and attach it in `PloneClient.__init__`.
+2. Accept item references through `self._resolve()` or `self._service()`, so paths, URLs and UIDs all work.
+3. Add a case to the table in the matching `tests/managers/` module, checking the method, path, query and body sent.
+4. If people will want it on the command line, add a command in `src/plone_client/cli/` and a test in `tests/cli/`.
+5. Add it to the table in `docs/reference/managers.md`, and to `docs/reference/compatibility.md` if it needs a newer `plone.restapi` than Plone 6.0.0 ships.
+
+## Write documentation
+
+The documentation follows the [Plone documentation style guide](https://6.docs.plone.org/contributing/documentation/index.html) and the [Diátaxis](https://diataxis.fr/) framework: tutorials, how-to guides, reference, and explanation each have their own folder in `docs/`.
+Write one sentence per line.
+Example scripts live in `docs/_examples/`, are included in the pages with `literalinclude`, and are checked by `make lint`.
+
+Docstrings use reStructuredText field lists: `:param:`, `:returns:` and `:raises:`.
+
+## Changelog
+
+Every pull request needs a news fragment in `news/`, which [towncrier](https://towncrier.readthedocs.io) collects at release time.
+Name it after the issue, such as `news/42.feature`, or `news/+short-name.feature` when there is none.
+The types are `breaking`, `feature`, `bugfix`, `internal`, `documentation` and `tests`.
+
+```text
+Added support for the @upgrade service. @your-github-username
+```
+
+## Report a bug
+
+Open an issue at <https://github.com/plone/plone-client/issues>, with the versions of plone-client, Plone and plone.restapi, and the smallest example that shows the problem.

plone_client-1.0.0a1/LICENSE.GPL

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.