Merge pull request #2 from vroncevic/dev

[atmanager] restructed project, updated docs

.gitignore

@@ -0,0 +1,24 @@
+__pycache__/
+*.py[cod]
+*$py.class
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+.python-version
+.idea/
+.vscode/

.readthedocs.yml

@@ -0,0 +1,6 @@
+version: 2
+python:
+  version: 2.7
+sphinx:
+  configuration: docs/source/conf.py
+formats: all

Dockerfile

@@ -0,0 +1,18 @@
+# Copyright 2018 Vladimir Roncevic <elektron.ronca@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+FROM debian:10
+RUN apt-get update
+RUN DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends apache2-dev tree htop

README.md

@@ -1,27 +1,83 @@
-# Apache Tomcat Manager (Bash script).
+# Apache Tomcat Manager.
+
+atmanager is shell tool for controling/operating Apache Tomcat Server.
+
+Developed in bash code: 100%.
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
 other information that should be provided before the tool is installed.
 
+[![GitHub issues open](https://img.shields.io/github/issues/vroncevic/atmanager.svg)](https://github.com/vroncevic/atmanager/issues)
+ [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/atmanager.svg)](https://github.com/vroncevic/atmanager/graphs/contributors)
+
 ### INSTALLATION
 
-To install this tool type the following:
+Navigate to release [page](https://github.com/vroncevic/atmanager/releases) download and extract release archive.
+
+To install modules type the following:
 
 ```
-cp -R ~/atmanager/bin/   /root/scripts/atmanager/ver.1.0/
-cp -R ~/atmanager/conf/  /root/scripts/atmanager/ver.1.0/
-cp -R ~/atmanager/log/   /root/scripts/atmanager/ver.1.0/
+tar xvzf atmanager-x.y.z.tar.gz
+cd atmanager-x.y.z
+cp -R ~/sh_tool/bin/   /root/scripts/atmanager/ver.1.0/
+cp -R ~/sh_tool/conf/  /root/scripts/atmanager/ver.1.0/
+cp -R ~/sh_tool/log/   /root/scripts/atmanager/ver.1.0/
+```
+
+Or You can use docker to create image/container.
+
+:sparkles:
+
+### USAGE
+
+```
+# Create symlink for shell tool
+ln -s /root/scripts/atmanager/ver.1.0/bin/atmanager.sh /root/bin/atmanager
+
+# Setting PATH
+export PATH=${PATH}:/root/bin/
+
+# Start Apache Tomcat
+atmanager start
 ```
 
 ### DEPENDENCIES
 
 This tool requires these other modules and libraries:
 
-	* sh_util https://github.com/vroncevic/sh_util
+* sh_util https://github.com/vroncevic/sh_util
+
+### SHELL TOOL STRUCTURE
+
+atmanager is based on MOP.
+
+Shell tool structure:
+```
+.
+├── bin/
+│   └── atmanager.sh
+├── conf/
+│   ├── atmanager.cfg
+│   └── atmanager_util.cfg
+└── log/
+    └── atmanager.log
+```
+
+### DOCS
+
+[![Documentation Status](https://readthedocs.org/projects/atmanager/badge/?version=latest)](https://atmanager.readthedocs.io/projects/atmanager/en/latest/?badge=latest)
+
+More documentation and info at:
+
+* https://atmanager.readthedocs.io/en/latest/
+
+:sparkles:
 
 ### COPYRIGHT AND LICENCE
 
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 Copyright (C) 2018 by https://vroncevic.github.io/atmanager
 
 This tool is free software; you can redistribute it and/or modify

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c3e5551d93051c0d24ca743d448dccf3
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. atmanager documentation master file, created by
+   sphinx-quickstart on Sat Mar 28 19:31:20 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to atmanager's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`