Create a Flojoy Block
To create a new Flojoy Block, you can use our CLI to generate the boilerplate code for you!
First, we recommend you to have just installed, this
allows you to type
just add BLOCK_NAME anywhere in the blocks repository,
instead of typing out the full command (
poetry run fjblocks.py add BLOCK_NAME)
Once you have just installed, head to anywhere in the blocks folder and
just add BLOCK_NAME.
For example, if I am in the
blocks/AI_ML/CLASSIFICATION/ folder, I can run
just add MY_NEW_ML_BLOCK and my new block will be located at
Contributute to Flojoy’s Blocks Collection
Here is a quick checklist to make sure everything is good before you make a PR.
- Make sure the block functions properly, and write a comprehensive docstring describing what it deos.
- Double check if there is any Python errors, looking for red squiggly lines in your code editor!
- We want the code format to look pretty and consistent!
(You can do so with
poetry run ruff format .or simply
- Show everyone how this block works! You should create an example app in
app.jsonand the description for this example app in
- Lastly, you can run
poetry run python3 fjblock.py syncor
just syncand make sure there is no errors.
Seems like a lot of steps! But this is how we make sure that every Flojoy Block is comprehensive and reliable in your workflow :)