Skip to content

Commit ed22d9e

Browse files
committed
readme update for release
1 parent d2ac4e9 commit ed22d9e

1 file changed

Lines changed: 11 additions & 27 deletions

File tree

README.md

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,12 @@
33
<a href="https://pypi.org/project/graphviz2drawio/"><img src="https://img.shields.io/pypi/v/graphviz2drawio.svg" alt="pypi"></a>
44
<a href="https://pypi.python.org/pypi/graphviz2drawio/"><img src="https://img.shields.io/pypi/pyversions/graphviz2drawio.svg" /></a>
55
[![Lint and Test](https://github.com/hbmartin/graphviz2drawio/actions/workflows/lint.yml/badge.svg)](https://github.com/hbmartin/graphviz2drawio/actions/workflows/lint.yml)
6-
[![codecov.io](https://codecov.io/github/hbmartin/graphviz2drawio/coverage.svg?branch=master)](https://codecov.io/github/hbmartin/graphviz2drawio?branch=master)
76
[![Code style: black](https://img.shields.io/badge/🐧️-black-000000.svg)](https://github.com/psf/black)
8-
[![Checked with pytype](https://img.shields.io/badge/🦆-pytype-437f30.svg)](https://google.github.io/pytype/)
97
[![twitter](https://img.shields.io/badge/@hmartin-00aced.svg?logo=twitter&logoColor=black)](https://twitter.com/hmartin)
108

119

1210
Convert graphviz (dot) files into draw.io (mxGraph) format.
1311

14-
## Roadmap for 0.3 release (as of July 2, 2024)
15-
16-
- [x] Migrate from Travis to GHA for CI
17-
- [ ] Migrate from Make to GHA for release
18-
- [x] Fix "cb" bug
19-
- [x] Add support for clusters
20-
- [x] Add support for edge labels
21-
- [x] Upgrade to latest pygraphviz
22-
- [x] Upgrade to latest svg.path
23-
- [x] Reformat for most recent black style
24-
- [ ] Publish api docs to GH pages
25-
- [ ] Remove this section before release! (move to release notes)
26-
2712
## Prerequisites
2813

2914
The graphviz library is required before installing this package.
@@ -45,7 +30,7 @@ export LDFLAGS="-L$(brew --prefix graphviz)/lib/"
4530
sudo apt install python3-pip graphviz graphviz-dev
4631
```
4732

48-
## CLI Installation
33+
## Installation
4934

5035
It is recommended to use [pipx](https://pipx.pypa.io/stable/) to install and run the CLI tool. If you wish to use the library, you can install with `pip` instead.
5136

@@ -57,10 +42,10 @@ pipx install -U graphviz2drawio
5742
## Usage
5843
Run the conversion app on your graphviz file
5944

60-
```
45+
```bash
6146
graphviz2drawio example.dot
6247
```
63-
You can them import the output XML file into draw.io
48+
You can then import the output XML file into draw.io
6449

6550
## Library Usage
6651
```python
@@ -71,9 +56,6 @@ print(xml)
7156
```
7257
where `graph_to_convert` can be any of a file path, file handle, string of dot language, or PyGraphviz.AGraph object
7358

74-
## Limitations
75-
Please [open an issue](https://github.com/hbmartin/graphviz2drawio/issues) with your dot file to report crashes or incorrect conversions.
76-
7759
## Built With
7860

7961
* [PyGraphviz](http://pygraphviz.github.io/documentation/pygraphviz-1.4rc1/reference/index.html) - Python interface to Graphviz
@@ -82,9 +64,9 @@ Please [open an issue](https://github.com/hbmartin/graphviz2drawio/issues) with
8264

8365
## Contributing
8466

85-
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
67+
Pull requests and issue reports are welcome. For major changes, please open an issue first to discuss what you would like to change.
8668

87-
## Developing
69+
### Development Setup
8870

8971
```bash
9072
git clone [email protected]:hbmartin/graphviz2drawio.git
@@ -97,23 +79,25 @@ python -m graphviz2drawio test/directed/hello.gv.txt
9779
```
9880

9981
## Roadmap to [0.4](https://github.com/hbmartin/graphviz2drawio/milestone/2)
100-
- [ ] Bezier curve support
82+
- [ ] Improved Bezier curve support
10183
- [ ] Subgraph conversion #33
10284
- [ ] Invisible node handling for edges #67
10385
- [ ] Implementation for outstanding TODOs in code
10486
- [ ] Image / tooltip support #49
10587
- [ ] Text on edge alignment #59
88+
- [ ] Text alignment inside of shape
10689
- [ ] Support for node with `path` shape #47
10790
- [ ] Run ruff in CI
91+
- [ ] Publish api docs to GH pages
92+
- [ ] Restore codecov to test GHA
10893

10994
## Roadmap to 1.0
110-
- [ ] Complete test suite for official graphviz examples
95+
- [ ] Complete test suite for all graphviz examples
11196
- [ ] Migrate to uv/hatch for packaging and dep mgmt
11297
- [ ] Port layout/orientation
113-
- [ ] Fix text alignment inside of shape
11498
- [ ] Possible to screenshot test with [maxGraph](https://github.com/maxGraph/maxGraph?tab=readme-ov-file) ?
11599

116100
## License
117101

118-
[GPLv3](LICENSE.md)
102+
© [Harold Martin](https://www.linkedin.com/in/harold-martin-98526971/) - released under [GPLv3](LICENSE.md)
119103

0 commit comments

Comments
 (0)