diff --git a/README.md b/README.md index 222e8397..9b8ed643 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,41 @@ [![Licence - GPLv3](https://img.shields.io/github/license/MathisFederico/Crafting?style=plastic)](https://www.gnu.org/licenses/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) -PyFlow is an open-source tool for modular visual programing in python ! +PyFlow is an open-source tool for modular visual programming in python ! Although for now the tool is in Beta and features are coming in bit by bit, stay tuned for the first release soon ! ![](media/mnist_example.gif) -## Help the project ! +## Community -Join our [Discord](https://discord.gg/xZq8Tp4srd) to beta-test features, share your ideas or even contribute ! +Join our [Discord](https://discord.gg/xZq8Tp4srd) to beta-test features, share your ideas, contribute or just to have a chat with us. ## Features -* Put your python code in small interconnected blocks +- Create blocks of code where you can edit and run Python code +

+ +

-* Export and Import your graphs and share them with other people in the new Interactive PYthon - Graph format (.ipyg) +- Move and resize blocks on an infinite 2D plane +

+ +

-* Chain your blocks to perform complex functions. +- Link blocks to highlight dependencies, Pyflow will then automatically run your blocks in the correct order + +

+ +

+ +- Convert your Jupyter notebooks to Pyflow graphs and vice versa + +

+ +

## Installation @@ -49,13 +64,15 @@ pip install -r requirements.txt Run ! ```bash -python -m opencodeblocks optional_path_to_ipyg +python -m opencodeblocks ``` ## Contributing If you are interested in contributing to the project, see [CONTRIBUTING.md](CONTRIBUTING.md). +You can also join our [Discord](https://discord.gg/xZq8Tp4srd) to get in touch with us. + ## License See [LICENSE](LICENSE) diff --git a/media/block_example.gif b/media/block_example.gif new file mode 100644 index 00000000..c999d290 Binary files /dev/null and b/media/block_example.gif differ diff --git a/media/flow_example.gif b/media/flow_example.gif new file mode 100644 index 00000000..61351450 Binary files /dev/null and b/media/flow_example.gif differ diff --git a/media/mnist_example.gif b/media/mnist_example.gif index 2a454e15..d8d2bb55 100644 Binary files a/media/mnist_example.gif and b/media/mnist_example.gif differ diff --git a/media/notebook_example.gif b/media/notebook_example.gif new file mode 100644 index 00000000..28bb4d10 Binary files /dev/null and b/media/notebook_example.gif differ diff --git a/media/resize_example.gif b/media/resize_example.gif new file mode 100644 index 00000000..5e7fc2b2 Binary files /dev/null and b/media/resize_example.gif differ