Metadata-Version: 2.4
Name: lockss-debugpanel
Version: 0.9.0.dev2
Summary: Command line tool and Python library to interact with the LOCKSS 1.x DebugPanel servlet
License: BSD-3-Clause
License-File: LICENSE
Author: Thib Guicherd-Callin
Author-email: thib@cs.stanford.edu
Maintainer: Thib Guicherd-Callin
Maintainer-email: thib@cs.stanford.edu
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Pydantic :: 2
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Archiving
Classifier: Topic :: Utilities
Requires-Dist: click-extra (>=7.5.0,<7.6.0)
Requires-Dist: lockss-pybasic (==0.2.0-dev11)
Project-URL: Documentation, https://docs.lockss.org/en/latest/software/debugpanel
Project-URL: Repository, https://github.com/lockss/lockss-debugpanel
Project-URL: changelog, https://github.com/lockss/lockss-debugpanel/blob/main/CHANGELOG.rst
Project-URL: issues, https://github.com/lockss/lockss-debugpanel/issues
Description-Content-Type: text/x-rst

==========
Debugpanel
==========

.. |RELEASE| replace:: 0.9.0-dev2
.. |RELEASE_DATE| replace:: NOT YET RELEASED
.. |DEBUGPANEL| replace:: **Debugpanel**

.. image:: https://assets.lockss.org/images/logos/debugpanel/debugpanel_128x128.png
   :alt: Debugpanel logo
   :align: right

|DEBUGPANEL| is a library and command line tool to interact with the LOCKSS 1.x DebugPanel servlet.

:Latest release: |RELEASE| (|RELEASE_DATE|)
:Documentation: https://docs.lockss.org/en/latest/software/debugpanel
:Release notes: `CHANGELOG.rst <https://github.com/lockss/lockss-debugpanel/blob/main/CHANGELOG.rst>`_
:License: `LICENSE <https://github.com/lockss/lockss-debugpanel/blob/main/LICENSE>`_
:Repository: https://github.com/lockss/lockss-debugpanel
:Issues: https://github.com/lockss/lockss-debugpanel/issues

----

Quick Start::

   # Requires Python 3.9-3.13
   python --version

   # Install with pipx
   pipx install lockss-debugpanel

   # Verify installation and discover all the commands
   debugpanel --help

   # Reload config on lockss1.example.edu:8081
   debugpanel reload-config -n lockss1.example.edu:8081

   # Crawl AUIDs from list.txt on lockss1.example.edu:8081 and lockss2.example.edu:8081

   # ...First alternative: each node gets a -n option
   debugpanel crawl -A list.txt -n lockss1.example.edu:8081 -n lockss2.example.edu:8081

   # ...Second alternative: each -n option can have arguments
   debugpanel crawl -A list.txt -n lockss1.example.edu:8081 lockss2.example.edu:8081

   # ...Third alternative: list lockss1.example.edu:8081 and lockss2.example.edu:8081 in nodes.txt
   debugpanel crawl -A list.txt -N nodes.txt


