Metadata-Version: 2.1
Name: pycg-producer
Version: 0.0.2
Summary: Call Graph Producer for PyPI Packages with the use of PyCG 
Home-page: https://github.com/fasten-project/pypi-tools/tree/main/cg-producer
Author: Georgios-Petros Drosos
Author-email: drosos007@gmail.com
License: Apache Software License
Description-Content-Type: text/markdown
License-File: LICENCE.txt

Library for generating PyPI Call Graphs through PyCG
====================================================

This library can be used to produce the call graph of a package distributed through pip along with saving its
source code and the call graph in json format in a specified directory.

Usage
-----

Example usage after installing the specific package through ```pip```:

``` python
from pycg_producer.producer import CallGraphGenerator

coord = { "product": "pycg-stitch",
          "version": "0.0.8",
          "version_timestamp": "2000",
          "requires_dist": []}
generator = CallGraphGenerator("directoryName", coord)
print(generator.generate())
```
The CallGraphGenerator class recieves as input the name of the directory where the source code and the call graph json will be stored, along with a python dictionary containing the product name and version of the specific pypi coordinate. 
*Note:* It is mandatory to provide also a ```version_timestamp``` and ```requires_dist``` fields, which can be left empty if they are not going to be used.
