marui 0.1.0

Find circular imports in a Python project.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# marui - Find circular imports in Python projects.

At work I work with a relatively large Python code base. Sometimes I find myself accidentally adding circular dependencies between modules. This leads to the classical

```shell
ImportError: cannot import name 'A' from partially initialized module 'B'
```

marui mitigates this problem by finding circular imports before you run your CI suite.

# Usage
In a Python project (characterized by a `pyproject.toml` being present), simply run
```shell
$ marui .
```

# Limitations

In the current version (0.1.0), `marui` can only find direct circular imports of Python modules. The plan for the next release is to extend this to finding circular import chains of any length using [directed graphs](https://en.wikipedia.org/wiki/Directed_graph) and  [strongly connected components](https://en.wikipedia.org/wiki/Strongly_connected_component).

# Installation
If you have cloned this repository, build and install marui with `cargo`:
```
$ gh repo clone jan-krecke/marui
$ cd marui
$ cargo install --path .
```

Alternatively, just get `marui` directly from `crates.io`:

```
$ cargo add marui
```

# Feeback and contribution
If you want to use this tool and find any problems, feel free to open a PR or an issue :-).