Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds gifs describing each main feature on the Readme #130

Merged
merged 3 commits into from
Jan 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<p align="center">
<img src="media/block_example.gif" width="400"/>
</p>

* 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

<p align="center">
<img src="media/resize_example.gif" width="400"/>
</p>

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

<p align="center">
<img src="media/flow_example.gif" width="400"/>
</p>

- Convert your Jupyter notebooks to Pyflow graphs and vice versa

<p align="center">
<img src="media/notebook_example.gif" width="400"/>
</p>

## Installation

Expand All @@ -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)
Binary file added media/block_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/flow_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/mnist_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/notebook_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/resize_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.