javacore-analyser 2.0rc1__py3-none-any.whl → 2.1__py3-none-any.whl

{javacore_analyser-2.0rc1.dist-info → javacore_analyser-2.1.dist-info}/METADATA

@@ -1,10 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.0rc1
+Version: 2.1
 Summary: The tool to review IBM Javacore files
 Project-URL: Homepage, https://github.com/IBM/javacore-analyser
 Project-URL: Issues, https://github.com/IBM/javacore-analyser/issues
-Project-URL: Changelog, https://github.com/IBM/javacore-analyser/CHANGELOG.md
+Project-URL: Changelog, https://github.com/IBM/javacore-analyser/blob/main/CHANGELOG.md
 Project-URL: Source, https://github.com/IBM/javacore-analyser
 Author-email: Krzysztof Kazmierczyk <kazm@ibm.com>, Piotr Aniola <Piotr.Aniola@ibm.com>, Tadeusz Janasiewicz <t.janasiewicz@ibm.com>
 License:                                  Apache License
@@ -209,6 +209,7 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -226,20 +227,30 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
-Requires-Dist: dicttoxml
 Requires-Dist: flask
 Requires-Dist: importlib-resources
 Requires-Dist: lxml
 Requires-Dist: py7zr
 Requires-Dist: pyana
+Requires-Dist: tqdm
 Requires-Dist: waitress
 Description-Content-Type: text/markdown
 
 <!-- This should be the location of the title of the repository, normally the short name -->
 # Javacore Analyser
 
+![GitHub License](https://img.shields.io/github/license/IBM/javacore-analyser)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/javacore-analyser)
+![GitHub contributors](https://img.shields.io/github/contributors/IBM/javacore-analyser)  
 <!-- Build Status, is a great thing to have at the top of your repository, it shows that you take your CI/CD as first class citizens -->
 [![Build Status](https://app.travis-ci.com/IBM/javacore-analyser.svg?token=w3i4X11XppEi2tJQsxDb&branch=main)](https://app.travis-ci.com/IBM/javacore-analyser)
+![GitHub last commit](https://img.shields.io/github/last-commit/IBM/javacore-analyser)
+![GitHub Release Date](https://img.shields.io/github/release-date/IBM/javacore-analyser)
+![GitHub commit activity](https://img.shields.io/github/commit-activity/t/IBM/javacore-analyser)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/IBM/javacore-analyser)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-closed/IBM/javacore-analyser)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/javacore-analyser)
+
 
 <!-- Not always needed, but a scope helps the user understand in a short sentance like below, why this repo exists -->
 ## Scope
@@ -266,7 +277,7 @@ Steps:
 3. Run the following command:
    `pip install javacore-analyser`  
     OR
-   `pip install --extra-index-url https://test.pypi.org/simple/ javacore-analyser` - if you want an experimental version
+   `pip install --pre --extra-index-url https://test.pypi.org/simple/ javacore-analyser` - if you want an experimental version
 
 #### Installing from sources
 This is recommended for geeks only:
@@ -280,29 +291,44 @@ This is recommended for geeks only:
 #### Running cmd application: 
 1. Install application if not done yet
 2. Activate your created virtual environment according to activate Virtual Environment according to [Creating virtual environments](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments)
-3. Install the requirements using pip: 
- `pip install requirements.txt` 
-4. Run the following command from cmd: `javacore-analyser-batch <input-data> <generated-reports-dir>`
+3. Run the following command from cmd:  
+`javacore-analyser-batch <input-data> <generated-reports-dir>`  
+or  
+`python -m javacore_analyser batch <input-data> <generated-reports-dir>`  
+
 Where `<input-data>` is one of the following:
 * The directory containing javacores and optionally verbose gc
 * Archive (7z, zip, tar.gz, tar.bz2) containing the same
 * List of the javacores separated by `;` character. Optionally you can add `--separator` option to define your own separator.
 You can type the following command to obtain the help:  
-`javacore-analyser-batch --help`
+`javacore-analyser-batch --help` or `python -m javacore_analyser barch --help`
 
 #### Running web application:
 1. Repeat steps 1-3 from cmd application
-2. OPTIONAL: set the following variables:
-  ```
-  export REPORTS_DIR=/tmp/reports  
-  export PORT=5000
-  ``` 
- The first parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.  
- The first parameter set the port to use by application. If not specified, 5000 will be used.  
-3. Execute the following command from cmd:  
-  `javacore_analyser_web`
-
-  Now you can type (http://localhost:5000/).  
+2. Execute the following command from cmd:  
+  `javacore_analyser_web --port=5000 --reports-dir=/data/reports_dir`  
+     or  
+  `python -m javacore_analyser web --port=5000 --reports-dir=/data/reports_dir`  
+
+   The first parameter set the port to use by application. If not specified, 5000 will be used.  
+   The second parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.  
+
+Now you can type (http://localhost:5000/).  
+
+### Running container image
+There is an unofficial Docker/Podman container managed by one of projects developers. Use the following command 
+to start it:
+
+`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`
+
+or  
+`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`  
+
+The `mount` option specifies where you want locally to store the reports. The reports in the container are stored in 
+`/reports` directory. If you remove mount option, the application will work but the reports will not persist after 
+restart.  
+The application is running in the container on port 5000. By using `-p 5001:5000` option, you specify to map container 
+port 5000 to port 5001 on your machine. Therefore the application will be available under `http://localhost:5001/`.
  
 <!-- The following are OPTIONAL, but strongly suggested to have in your repository. -->
 <!--

javacore_analyser-2.1.dist-info/RECORD

@@ -0,0 +1,46 @@
+javacore_analyser/__init__.py,sha256=Sw2ZeqcI2Kx1cDDv083n1SiSY_FDRCmidTuzaN1uRSw,76
+javacore_analyser/__main__.py,sha256=wQCPgu8Gp7XczyNckNGmY30c5YMUMRByW7jrdFO0OBY,1694
+javacore_analyser/abstract_snapshot_collection.py,sha256=jGfd2XgujurRlKgEtlJjqNJK9sUvTdFsdgFnX9oLzt4,5589
+javacore_analyser/code_snapshot_collection.py,sha256=6_C5myag5ocjOTwXVDbBamN6Lf1szgS3ylSHEEjUdVg,2655
+javacore_analyser/constants.py,sha256=iGYAznPK8AySq6uqk-cpCU8Dbjbq6PrCh6q2mF8oeu8,1003
+javacore_analyser/java_thread.py,sha256=4zUfmmlH47SrIxgfPmrJHl_YUziVJXVNVedD5X25vXY,4464
+javacore_analyser/javacore.py,sha256=_2abTyvXEaZ6Tx8r9d3NEzRCIBcf4Is8lSjpKyPu-R8,6884
+javacore_analyser/javacore_analyser_batch.py,sha256=bz2ukMp-S8HX4-t8bjtiz5RSOVaeuztFp6pUTAmyM60,7058
+javacore_analyser/javacore_analyser_web.py,sha256=o-Spq119Wi7w4pvBa7M7ZrxiZnzKmWqDhCdGtEReQAU,5951
+javacore_analyser/javacore_set.py,sha256=81bKBwn4GHdPkKH4yb2j3z1HPKrys1KTBon1TTUH5gI,31469
+javacore_analyser/logging_utils.py,sha256=vLob0ikezysjGv9XGqv9GbLekxu4eO_csq22M-gtLiQ,966
+javacore_analyser/snapshot_collection.py,sha256=fLEnwg9-cOjVVUUludtzI7R2yO9BBVgJgxkhvqG5QDg,443
+javacore_analyser/snapshot_collection_collection.py,sha256=1PV1TX4QQk01dAbX-k-kTpgKr6Il867Bw6X7HHBuv-Q,1346
+javacore_analyser/stack_trace.py,sha256=8sb8z4ac_L0yyxqJX1ukrTZRyngkHcA3zkXyqxG5ygA,1664
+javacore_analyser/stack_trace_element.py,sha256=pZPrK1ACBUDE7YsVOFhTfewXequ1m5P-B0N-9RuhkWo,1143
+javacore_analyser/stack_trace_kind.py,sha256=lOdfb_F3XrwDLciPk_ZgM_fmMn5JoXsIUjr7pjvmU4M,157
+javacore_analyser/thread_snapshot.py,sha256=2Do8NPBXdpUezQrUI_9nyGbtU4b2s5euPnHqcuuKq7U,13255
+javacore_analyser/tips.py,sha256=EhwLUAha0FvFJtO5kmvba9a1nKXGdqNHFa2jFbHZr4U,8655
+javacore_analyser/verbose_gc.py,sha256=r5ZOZVhdrrgFTGo1Rx-FFPFNRpvX1jflP6AkNATMpIQ,6871
+javacore_analyser/data/expand.js,sha256=KwqvNUoO7yMDeQKcnLDywfMdR3Zsjan5L8QoPsQQLGo,956
+javacore_analyser/data/style.css,sha256=YzHl0NSnfRik4ar6AInp7pZ_re1rirQy6L5jqdbKoKg,2246
+javacore_analyser/data/html/processing_data.html,sha256=S1S2GMXQ8oQdqdYTcPzVMxUib-NLtM4ffT3OJaIIO7w,421
+javacore_analyser/data/jquery/chart.js,sha256=tgiW1vJqfIKxE0F2uVvsXbgUlTyrhPMY_sm30hh_Sxc,203464
+javacore_analyser/data/jquery/chartjs-adapter-date-fns.bundle.min.js,sha256=6nqzDSbDjc8fLSa7Q-c6lFN7WPGQb1XhpUbdCTIbVhU,50650
+javacore_analyser/data/jquery/jq.css,sha256=CXwJ7OOkFWXsebmAipjne1TnNanpp_2z241eLsVB7Ls,6751
+javacore_analyser/data/jquery/jquery.mark.min.js,sha256=p_nep2K57or4Km0eXahvl6J_geaGx-wwGqIGSNhGUa4,8123
+javacore_analyser/data/jquery/jquery.min.js,sha256=pvPw-upLPUjgMXY0G-8O0xUf-_Im1MZjXxxgOcBQBXU,89947
+javacore_analyser/data/jquery/jquery.tablesorter.min.js,sha256=dtGH1XcAyKopMui5x20KnPxuGuSx9Rs6piJB_4Oqu6I,44365
+javacore_analyser/data/jquery/jquery.tablesorter.widgets.min.js,sha256=GxbszpUzg-iYIcyDGyNVLz9Y0dQvzmQgXXVk5cHJbw0,53100
+javacore_analyser/data/jquery/search.js,sha256=Jwi-cBJ9YKDHJwqIlcKXqrpcM1BX-wx93uKAR44JLww,4200
+javacore_analyser/data/jquery/sorting.js,sha256=HsuVLa7F70IM4ZMXZpjj7wtVI1TXL1SPbZGWenv0Jp8,369
+javacore_analyser/data/jquery/theme.blue.css,sha256=mI0RCGd6G5GOKSG7BPagp0N58xipSjPXUKvrcHJ4h1Q,7528
+javacore_analyser/data/jquery/theme.default.min.css,sha256=5sgExNTnkN8NcApKIU73_aqgZmqq_zJp9-9zXf9aSEw,4502
+javacore_analyser/data/jquery/wait2scripts.js,sha256=z6zmSAak0R6bjh7BeHlIOSImiZSy5Y3z5ygMiN-sPxI,8460
+javacore_analyser/data/xml/index.xml,sha256=9VH2rmri3FQpXcW39kbyi2dON94C5XTiaQn0ioExCe8,282
+javacore_analyser/data/xml/report.xsl,sha256=qJG0AvYWJSNOnhH5jmSwCPJH_4k5qwCJR23UqROcon4,51012
+javacore_analyser/data/xml/javacores/javacore.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
+javacore_analyser/data/xml/javacores/javacore.xsl,sha256=5cnIp08Q9FccljHH8duoJQYofyW8lwUCGtpdzz5Y0Y8,11644
+javacore_analyser/data/xml/threads/thread.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
+javacore_analyser/data/xml/threads/thread.xsl,sha256=rkqr5GQ2aZ_xrdhUjl2QZDCZ-09zxqUmtV8DFZVjTAA,13927
+javacore_analyser/templates/index.html,sha256=aEuyry-HZ9HlQNwfbugugvqbSxwlo7LrQnrDmqO34YE,1682
+javacore_analyser-2.1.dist-info/METADATA,sha256=nsUGKcsweg5PjHtSOXyzr2rJ_GwAyr0tiaynpT9ptkM,22257
+javacore_analyser-2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+javacore_analyser-2.1.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
+javacore_analyser-2.1.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+javacore_analyser-2.1.dist-info/RECORD,,

{javacore_analyser-2.0rc1.dist-info → javacore_analyser-2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

javacore_analyser-2.0rc1.dist-info/RECORD

@@ -1,44 +0,0 @@
-javacore_analyser/__init__.py,sha256=Sw2ZeqcI2Kx1cDDv083n1SiSY_FDRCmidTuzaN1uRSw,76
-javacore_analyser/abstract_snapshot_collection.py,sha256=zXLRPQRdFpOufC8OVMh1wAhFnFDYQgWy10zZOZWaZQc,5592
-javacore_analyser/code_snapshot_collection.py,sha256=6_C5myag5ocjOTwXVDbBamN6Lf1szgS3ylSHEEjUdVg,2655
-javacore_analyser/constants.py,sha256=hGEsldGuuJGqy1iM7POiQnjVqNLclO5CjIKeIW2oeIQ,924
-javacore_analyser/java_thread.py,sha256=4zUfmmlH47SrIxgfPmrJHl_YUziVJXVNVedD5X25vXY,4464
-javacore_analyser/javacore.py,sha256=NkvxN6C93eG24wEB_kfH-yf0_f_ECj7Let4bQ1i22AM,6860
-javacore_analyser/javacore_analyser_batch.py,sha256=ApC_xcDMIP4DxQ0MUiD6XrF3hzcyFmofVH1Jq4-6_4s,5408
-javacore_analyser/javacore_analyser_web.py,sha256=DJgzHKuGUkATKaE7pI6zOQPGITB6hdM86tUXsZ1fCWw,4526
-javacore_analyser/javacore_set.py,sha256=3EIl3Wrq3RUo3APfHmDq4Nllq5_ufSC9qZquogiy4ns,29420
-javacore_analyser/logging_utils.py,sha256=vLob0ikezysjGv9XGqv9GbLekxu4eO_csq22M-gtLiQ,966
-javacore_analyser/snapshot_collection.py,sha256=fLEnwg9-cOjVVUUludtzI7R2yO9BBVgJgxkhvqG5QDg,443
-javacore_analyser/snapshot_collection_collection.py,sha256=JyNr038nC8mcX1mjeXjNSzZT4oE9ACFmCYJORUKzyvw,1265
-javacore_analyser/stack_trace.py,sha256=RY1nmvSA_lyRqVejHcXBbxT8EhbkJPktBqsQ4kKSgtA,1661
-javacore_analyser/stack_trace_element.py,sha256=1WOV7pilb8RAc_hMN7lsXMrPevW6WFHAaLOGpsMmJgs,1145
-javacore_analyser/stack_trace_kind.py,sha256=lOdfb_F3XrwDLciPk_ZgM_fmMn5JoXsIUjr7pjvmU4M,157
-javacore_analyser/thread_snapshot.py,sha256=TR0StpE-r4FYax8oULUANBsKJDYX3FQ0lwzwnvEPxic,13193
-javacore_analyser/tips.py,sha256=pA8mpmyPk9RXPVt5GFiB9dlhiBeiGPKUBgJgvPRUmLk,8608
-javacore_analyser/verbose_gc.py,sha256=mSFIRb-thl5nrdEd_SOxFcvobso_07NQ2_g1_9IXgY0,6782
-javacore_analyser/data/expand.js,sha256=mNjvT_00YHQxWhlAQwFElzlhBWvKP5WEMSWJkL1PKl8,954
-javacore_analyser/data/style.css,sha256=YzHl0NSnfRik4ar6AInp7pZ_re1rirQy6L5jqdbKoKg,2246
-javacore_analyser/data/jquery/chart.js,sha256=tgiW1vJqfIKxE0F2uVvsXbgUlTyrhPMY_sm30hh_Sxc,203464
-javacore_analyser/data/jquery/chartjs-adapter-date-fns.bundle.min.js,sha256=6nqzDSbDjc8fLSa7Q-c6lFN7WPGQb1XhpUbdCTIbVhU,50650
-javacore_analyser/data/jquery/jq.css,sha256=CXwJ7OOkFWXsebmAipjne1TnNanpp_2z241eLsVB7Ls,6751
-javacore_analyser/data/jquery/jquery.mark.min.js,sha256=p_nep2K57or4Km0eXahvl6J_geaGx-wwGqIGSNhGUa4,8123
-javacore_analyser/data/jquery/jquery.min.js,sha256=pvPw-upLPUjgMXY0G-8O0xUf-_Im1MZjXxxgOcBQBXU,89947
-javacore_analyser/data/jquery/jquery.tablesorter.min.js,sha256=dtGH1XcAyKopMui5x20KnPxuGuSx9Rs6piJB_4Oqu6I,44365
-javacore_analyser/data/jquery/jquery.tablesorter.widgets.min.js,sha256=GxbszpUzg-iYIcyDGyNVLz9Y0dQvzmQgXXVk5cHJbw0,53100
-javacore_analyser/data/jquery/search.js,sha256=hY0kp5ZIUazzM32hEmArA3ql6MTiOjjf5wosxXvowAw,3398
-javacore_analyser/data/jquery/sorting.js,sha256=HsuVLa7F70IM4ZMXZpjj7wtVI1TXL1SPbZGWenv0Jp8,369
-javacore_analyser/data/jquery/theme.blue.css,sha256=mI0RCGd6G5GOKSG7BPagp0N58xipSjPXUKvrcHJ4h1Q,7528
-javacore_analyser/data/jquery/theme.default.min.css,sha256=5sgExNTnkN8NcApKIU73_aqgZmqq_zJp9-9zXf9aSEw,4502
-javacore_analyser/data/jquery/wait2scripts.js,sha256=DmSgbHk_nP-9Echk1OwvdVXi_MwsfdFe0F7qIyfmsbM,8054
-javacore_analyser/data/xml/index.xml,sha256=9VH2rmri3FQpXcW39kbyi2dON94C5XTiaQn0ioExCe8,282
-javacore_analyser/data/xml/report.xsl,sha256=ZFcy8dfEB7rTQwcQvUKKSvyEl7HylXgjHjD7bWVpYes,49693
-javacore_analyser/data/xml/javacores/javacore.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
-javacore_analyser/data/xml/javacores/javacore.xsl,sha256=9FANZSXy1pTKIkb2pMQBS9IxOfAK2yKRzsKlabs-X2g,10509
-javacore_analyser/data/xml/threads/thread.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
-javacore_analyser/data/xml/threads/thread.xsl,sha256=YvfwICfSDNQbB7tSrISCdlQ1hTNkfiEFd0XtO7-Lhb0,12636
-javacore_analyser/templates/index.html,sha256=3XVMLjUOv8e5ISW_Z4OyvVuBxnb2Ytrq-seC810kUq8,1582
-javacore_analyser-2.0rc1.dist-info/METADATA,sha256=ZA-ftJphoR5Tb37o6_rpGjuVquHAhg2c2rxuVgVGU0c,20363
-javacore_analyser-2.0rc1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-javacore_analyser-2.0rc1.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
-javacore_analyser-2.0rc1.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-javacore_analyser-2.0rc1.dist-info/RECORD,,