a-recknagel/byecycle

Find and expose cyclic imports in python projects.

byecycle's Issues

Add tests for `--draw` option

How to test for pictures to have been generated correctly though. Compare pixels?

Use a better / alternative drawing backend

matplotlib isn't the best tool for drawing graphs, just the one I was familiar with. once the picture gets a bit bigger and more cluttered, features like

• zooming in/out
• a tooltip showing the module name instead of having to color-match with a legend-chart
• things being prettier in general

would be really nice.

Generate coverage badge

Now that the test coverage isn't horrible any more, I'm not ashamed to show it. Unfortunately, github-actions doesn't provide an easy way to do so. Requirements:

• obtain cloud storage
• add anybadge to dev dependencies (docs group maybe?)
• write a scripts/badges.py script that generates a badge based on a coverage report
• run coverage in pipeline, store report as artifact (the unit test job already runs coverage, but doesn't generate/store the report)
• run badger-job in pipeline which
  • fetches the coverage report
  • runs scripts/badges.py with it as input
  • pushes the resulting badge to the cloud

Once that is done, the readme can feature that badge.

add issue templates

describing how issues should be written in docs is a lot worse than just providing a template. as a starting point:

• template for bugs
• template for feature requests

and maybe one more for docs and/or "other". then again, such things might better be described with labels.

Restructure internals

The Module class is badly designed. Shared state on the class level that requires manual cleanup means that something fundamental is wrong. Probably the fact that it claims to be a Node-like class and lacks both parent or children linkage -- imports are not children, even if you can draw graphs with them.