Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!

Recommended Dev structure for Platform SDK

SeanAdams
17 - Castor
17 - Castor

Hi all,

 

When we use the Platform SDK, the recommendation is to create a virtual environment for this purpose.    

Could anyone suggest how they have set up their dev env and folder structure for this purpose?   For example - is the Venv under the same folder structure as your source code that you're developing?

 

The challenge I have with this (screenshot below) is the VENV then gets added to GIT and so your GIT project now becomes huge (715MB), so it seems that there must be a better way to structure this stuff.

 

cc: @jarrod @jdunkerley79 

 

 

DevEnv.png

2 REPLIES 2
cam_w
11 - Bolide

Hey @SeanAdams !

 

Definitely update your .gitignore file as first step to ignore files that you do not want to include in your git repo. Here's an example of mine:

.idea
.vscode
.ipynb_checkpoints
*.ipynb
*.zip
*.pyc
*.bak

package/*
!package/Config.*
!package/icon.png

env/**
!env/requirements-directory.txt
!env/setup_environ.bat

 

As to directory structure, I use the following:

 

CamsNewTools:

 - venv:

 - src:

 - .gitignore

 - etc.

SeanAdams
17 - Castor
17 - Castor

🙂 thank you for the response @cam_w - gonna try this today or over the weekend.    I had never used the .gitignore file, so this is good learning