Metadata-Version: 2.1
Name: akarsu
Version: 0.1.0
Summary: New Generation Profiler based on PEP 669
Author-email: Furkan Onder <furkanonder@protonmail.com>
License: The MIT License (MIT)
        =====================
        
        Copyright © `2023` `Furkan Onder`
        
        Permission is hereby granted, free of charge, to any person
        obtaining a copy of this software and associated documentation
        files (the “Software”), to deal in the Software without
        restriction, including without limitation the rights to use,
        copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the
        Software is furnished to do so, subject to the following
        conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
        OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/furkanonder/akarsu
Project-URL: Bug Reports, https://github.com/furkanonder/akarsu/issues
Project-URL: Source, https://github.com/furkanonder/akarsu
Keywords: profiler,PEP669
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt

_akarsu_ is the New Generation Profiler based on
[PEP 669](https://peps.python.org/pep-0669/). The name of the project, comes from the
surname of a minstrel named `Muhlis Akarsu`, which means `stream`.

## Installation

_akarsu_ can be installed by running `pip install akarsu`. It requires Python 3.12.0+ to
run.

## Usage

```sh
cat example.py
```

Output:

```python
def foo():
    x = 1
    isinstance(x, int)
    return x


def bar():
    foo()


bar()
```

---

```sh
akarsu -f example.py
```

Output:

```
     Count     Event Type     Filename(function)
         1      PY_CALL       example.py(bar)
         1      PY_START      example.py(bar)
         1      PY_CALL       example.py(foo)
         1      PY_START      example.py(foo)
         1       C_CALL       example.py(<built-in function isinstance>)
         1      C_RETURN      example.py(foo)
         1     PY_RETURN      example.py(foo)
         1     PY_RETURN      example.py(bar)

Total number of events: 8
  PY_CALL = 2
  PY_START = 2
  PY_RETURN = 2
  C_CALL = 1
  C_RETURN = 1
```
