Metadata-Version: 2.1
Name: tomcatmanager
Version: 1.0.2
Summary: A command line tool and python library for managing a tomcat server.
Home-page: https://github.com/tomcatmanager/tomcatmanager
Author: Jared Crapo
Author-email: jared@kotfu.net
License: MIT
Description: tomcatmanager
        =============
        
        .. image:: https://img.shields.io/pypi/v/tomcatmanager.svg?label=latest%20version&colorB=1074b5
              :target: https://pypi.python.org/pypi/tomcatmanager
              :alt: latest version
        .. image:: https://img.shields.io/pypi/pyversions/tomcatmanager.svg?colorB=1074b5
              :target: https://pypi.python.org/pypi/tomcatmanager
              :alt: python
        .. image:: https://img.shields.io/badge/license-MIT-orange.svg
              :target: https://github.com/tomcatmanager/tomcatmanager/blob/master/LICENSE
              :alt: license
        .. image:: https://img.shields.io/travis/tomcatmanager/tomcatmanager/develop.svg
              :target: https://travis-ci.org/tomcatmanager/tomcatmanager
              :alt: build status
        .. image:: https://img.shields.io/appveyor/ci/kotfu/tomcatmanager/develop.svg
              :target: https://ci.appveyor.com/project/kotfu/tomcatmanager
              :alt: build status
        .. image:: https://img.shields.io/codecov/c/github/tomcatmanager/tomcatmanager/develop.svg
              :target: https://codecov.io/gh/tomcatmanager/tomcatmanager
              :alt: code coverage
        .. image:: https://readthedocs.org/projects/tomcatmanager/badge/?version=latest
              :target: http://tomcatmanager.readthedocs.io/en/latest/?badge=latest
              :alt: Documentation Status
        
        If you use Apache Tomcat for any sort of development work you’ve probably deployed lots of applications to it. There are a several ways to get your war files deployed:
        
        - use the `Tomcat Manager <https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html>`_
          application in your browser
        - use the `Tomcat Ant Tasks <https://cwiki.apache.org/confluence/display/tomcat/AntDeploy>`_ included with
          Tomcat
        - use `Cargo <https://codehaus-cargo.github.io/>`_ and its plugins for ant and maven
        
        Here's another way: a command line tool and python library for managing a
        Tomcat server.
        
        
        What Can It Do?
        ---------------
        
        This package installs a command line utility called ``tomcat-manager``. It's
        easily scriptable using your favorite shell:
        
        .. code-block:: text
        
           $ tomcat-manager --user=ace --password=newenglandclamchowder \
           http://localhost:8080/manager deploy local sample.war /sampleapp
           $ echo $?
           0
        
        There is also an interactive mode:
        
        .. code-block:: text
        
           $ tomcat-manager
           tomcat-manager>connect http://localhost:8080/manager ace newenglandclamchowder
           --connected to http://localhost:8080/manager as ace
           tomcat-manager>list
           Path                     Status  Sessions Directory
           ------------------------ ------- -------- ------------------------------------
           /                        running        0 ROOT
           /sampleapp               stopped        0 sampleapp##9
           /sampleapp               running        0 sampleapp##8
           /host-manager            running        0 /usr/share/tomcat8-admin/host-manage
           /manager                 running        0 /usr/share/tomcat8-admin/manager
        
        And for the ultimate in flexibility, you can use the python package directly:
        
        .. code-block:: python
        
           >>> import tomcatmanager as tm
           >>> tomcat = tm.TomcatManager()
           >>> r = tomcat.connect(url='http://localhost:8080/manager',
           ... user='ace', password='newenglandclamchowder')
           >>> tomcat.is_connected
           True
           >>> r = tomcat.stop('/someapp')
           >>> r.status_code == tm.status_codes.ok
           False
           >>> r.status_message
           'No context exists named /someapp'
        
        
        Installation
        ------------
        
        You'll need Python >= 3.5. Install using pip:
        
        .. code-block:: bash
        
           $ pip install tomcatmanager
        
        Works on Windows, macOS, and Linux.
        
        
        Tomcat Configuration
        --------------------
        
        This library and associated tools do their work via the Tomcat Manager
        web application included in the Tomcat distribution. You will need to
        configure authentication in ``tomcat-users.xml`` with access to the
        ``manager-script`` role:
        
        .. code-block:: xml
        
           <tomcat-users>
             ...
             <role rolename="manager-script"/>
             <user username="ace" password="newenglandclamchowder" roles="manager-script"/>
             ...
           </tomcat-users>
        
        
        Features
        --------
        
        The ``tomcat-manager`` command line tool supports the following commands:
        
        - **deploy** - deploy a war file containing a tomcat application in the tomcat server
        - **redeploy** - remove the application currently installed at a given path and install a new war file there
        - **undeploy** - remove an application from the tomcat server
        - **start** - start a tomcat application that has been deployed but isn't running
        - **stop** - stop a tomcat application and leave it deployed on the server
        - **reload** - stop and start a tomcat application
        - **sessions** - show active sessions for a particular tomcat application
        - **expire** - expire idle sessions
        - **list** - show all installed applications
        - **serverinfo** - show information about the server, including tomcat version, OS version and architecture, and jvm version
        - **status** - show server status information in xml format
        - **vminfo** - show diagnostic information about the jvm
        - **sslconnectorciphers** - show ssl/tls ciphers configured for each connector
        - **threaddump** - show a jvm thread dump
        - **resources** - show the global jdni resources configured in tomcat
        - **findleakers** - show tomcat applications that leak memory
        
        
        Documentation
        -------------
        
        Complete documentation is available at `<http://tomcatmanager.readthedocs.io/en/latest/>`_
        
Keywords: java tomcat command line
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Provides-Extra: dev
