Metadata-Version: 1.1
Name: git-stacktrace
Version: 1.0.0
Summary: git-blame for stacktraces
Home-page: https://github.com/pinterest/git-stacktrace
Author: Joe Gordon
Author-email: UNKNOWN
License: Apache License (2.0)
Description: git-stacktrace
        ==============
        
        git-stacktrace is a tool to help you associate git commits with stacktraces.
        
        It helps you identify related commits by looking at:
        
        * commits in given range that touched files present in the stacktrace
        * commits in given range that added/removed code present in the stacktrace
        
        Supported Languages
        -------------------
        
        * Python
        * Java
        * `JavaScript <https://v8.dev/docs/stack-trace-api>`_
        
        Development
        ------------
        
        Run tests with: ``tox``
        
        Installation
        ------------
        
        .. code-block:: sh
        
            $ pip install git_stacktrace
        
        Usage
        -----
        
        Run ``git stacktrace`` within a git initialized directory.
        
        .. code-block:: sh
        
            usage: git stacktrace [<options>] [<RANGE>] < stacktrace from stdin
        
            Lookup commits related to a given stacktrace.
        
            positional arguments:
              range                 git commit range to use
        
            optional arguments:
              -h, --help            show this help message and exit
              --since <date1>       show commits more recent than a specific date (from
                                    git-log)
              --server              start a webserver to visually interact with git-
                                    stacktrace
              --port PORT           Server port
              -f, --fast            Speed things up by not running pickaxe if the file for
                                    a line of code cannot be found
              -b [BRANCH], --branch [BRANCH]
                                    Git branch. If using --since, use this to specify
                                    which branch to run since on. Runs on current branch
                                    by default
              --version             show program's version number and exit
              -d, --debug           Enable debug logging
        
        
        For the Python API see: ``git_stacktrace/api.py``
        
        To run as a web server: ``git stacktrace --server --port=8080``
        or ``GIT_STACKTRACE_PORT=8080 git stacktrace --server``
        
        Use the web server as an API:
        
        .. code-block:: sh
        
            $ curl \
              -d '{"option-type":"by-date", "since":"1.day", "trace":"..."}' \
              -H "Content-Type: application/json" \
              -X POST http://localhost:8080/
        
        
        Examples
        --------
        
        Example output::
        
        
            $ git stacktrace --since=1.day < trace
            Traceback (most recent call last):
             File "webapp/framework/resource.py", line 72, in _call
               result = getattr(self, method_name)()
             File "webapp/resources/interests_resource.py", line 232, in get
               if self.options['from_navigate'] == "true":
            KeyError
        
        
            commit da39a3ee5e6b4b0d3255bfef95601890afd80709
            Commit Date: Tue, 19 Jul 2016 14:18:08 -0700
            Author:      John Doe <johndoe@pinterest.com>
            Subject:     break interest resource
            Link:        https://example.com/D1000
            Files Modified:
               - webapp/resources/interests_resource.py:232
            Lines Added:
               - "if self.options['from_navigate'] == "true":"
        
        Change Log
        ==========
        
        1.0.0
        -----
        
        * Add Python 3.8 support drop Python 2.7 support (https://github.com/pinterest/git-stacktrace/pull/33)
        
        0.9.0
        -----
        
        * Add support for javascript (https://github.com/pinterest/git-stacktrace/pull/24)
        
        0.8.1
        -----
        
        * Add several missing rare git file states (T, U, X)
        
        0.8.0
        -----
        
        * Fix pickaxe support for python3
        * Improve java traceback support
        * Improve the python api
        
        0.7.2
        -----
        
        * Fix python traceback parsing with no code on last line (https://github.com/pinterest/git-stacktrace/pull/13)
        
        0.7.1
        -----
        
        * Fix python traceback parsing where code is missing (https://github.com/pinterest/git-stacktrace/issues/10)
        * Add --debug flag
        
        0.7.0
        -----
        
        * Add python 3 support
        
        0.6.0
        -----
        
        * Support arbitrary sized abbreviated hashes
        * Clarify CLI help message
        
        0.5.0
        -----
        
        * Match file line numbers in stacktrace to lines changed in commits
        * Differentiate files added, deleted and modified
        * print stacktrace headers and footers
        * Fix git pickaxe error (Use '--' to separate paths from revisions)
        * Add initial java stacktrace support. Begin supporting basic java stacktraces, some more complex formats are not supported yet.
        
        0.4.1
        -----
        
        * Get ready for pypi
        
        0.4.0
        -----
        
        * Initial open source commit
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
