[cli] Initialize Python application without setup.py

[alexpulver]

cdk init --language python generates setup.py file, and requirements.txt file with -e ., that installs the project in editable mode (i.e. setuptools “develop mode”) from local path. This approach is used for distributing Python code to developers - a reusable construct in CDK case. CDK application is not a reusable construct, hence shouldn't have setup.py, and only list its direct dependencies in requirements.txt.

Use Case

Make cdk init --language python scaffolding more aligned with Python guidance on packaging applications as compared to packaging libraries and tools

Proposed Solution

Remove setup.py and -e . from requirements.txt when running cdk init --language python

Other

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[polothy]

I ran into this same problem and Intellij treats the project "funny" (read: not in a good way). I ended up removing setup.py and everything behaves a lot better.

[ghost]

I always thought this was a bit unusual myself.

[shivlaks]

@alexpulver thanks for logging this feature request, I agree that we should be aligning ourselves with Python guidance on packaging applications.

[alexpulver]

Hey @shivlaks, is there any update on this?

[Jacco]

Verified with CDK version 2.23.0: no setup.py is generated.

I think this issue can be closed.

% cdk --version
2.23.0 (build 50444aa)
% ls -lah
total 56
drwxr-xr-x  13 jaccokulman  staff   416B  8 mei 13:18 .
drwxr-xr-x@  7 jaccokulman  staff   224B  8 mei 13:20 ..
drwxr-xr-x  12 jaccokulman  staff   384B  8 mei 13:20 .git
-rw-r--r--   1 jaccokulman  staff   119B  8 mei 13:20 .gitignore
drwxr-xr-x   6 jaccokulman  staff   192B  8 mei 13:20 .venv
-rw-r--r--   1 jaccokulman  staff   1,6K  8 mei 13:20 README.md
-rw-r--r--   1 jaccokulman  staff   935B  8 mei 13:20 app.py
-rw-r--r--   1 jaccokulman  staff   871B  8 mei 13:20 cdk.json
drwxr-xr-x   4 jaccokulman  staff   128B  8 mei 13:20 init_tst2
-rw-r--r--   1 jaccokulman  staff    14B  8 mei 13:20 requirements-dev.txt
-rw-r--r--   1 jaccokulman  staff    47B  8 mei 13:20 requirements.txt
-rw-r--r--   1 jaccokulman  staff   437B  8 mei 13:20 source.bat
drwxr-xr-x   4 jaccokulman  staff   128B  8 mei 13:20 tests

[jazzabeanie]

Std out from cdk init --language=python still says:

To add additional dependencies, for example other CDK libraries, just add
them to your `setup.py` file and rerun the `pip install -r requirements.txt`
command.

[Jacco]

Std out from cdk init --language=python still says:

To add additional dependencies, for example other CDK libraries, just add
them to your `setup.py` file and rerun the `pip install -r requirements.txt`
command.

Ah yes, missed that :-) I guess that should read:

To add additional dependencies, for example other CDK libraries, just add
them to your `requirements.txt` file and rerun the `pip install -r requirements.txt`
command.

I am not too experienced in python though. In npm there is an option to save to package.json automatically.

The template can be changed here:

aws-cdk/packages/aws-cdk/lib/init-templates/v2/app/python/README.template.md

Lines 46 to 48 in 87786f4

	To add additional dependencies, for example other CDK libraries, just add
	them to your `setup.py` file and rerun the `pip install -r requirements.txt`
	command.

Happy to make a PR if the text above is ok :-)

[jazzabeanie]

I don't think there is an equivalent to npn install --save. What you've got there looks good to me, although, docs do say to run
python -m pip install -r requirements.txt. I have a feeling that it's something to do with having a command that also works on Windows.