PNNL-CIM-Tools / CIM-Graph

Python library for creating in-memory labeled property graphs for creating, parsing, and editing CIM power system models
https://cimantic-graphs.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
11 stars 8 forks source link

Include the summary image in the package #56

Open craig8 opened 10 months ago

craig8 commented 10 months ago

There is a reference in the README that is not available from the develop branch. It will get taken care off when we go live, but if we want to make sure it is in the pypi readme we need to add it to the data or make it fully resolved.

craig8 commented 10 months ago

@AAndersn thoughts?

AAndersn commented 10 months ago

@craig8 - it is at the same level as the readme -- does it need to be moved inside the package?

https://github.com/PNNL-CIM-Tools/CIM-Graph/blob/develop/cim_graph_structure.png

craig8 commented 10 months ago

I am saying https://pypi.org/project/cim-graph/ doesn't have the image. So we can put a full path link to https://github.com/PNNL-CIM-Tools/CIM-Graph/blob/develop/cim_graph_structure.png in the readme and fix the issue.

Rather than the relative path cim_graph_structure.png which I believe is what we have currently.

The issue is that pypi doesn't know anything about the structure within the repository.