Cookiecutter not working

[staceywhitmore-inl]

I tried following the general trame app cookiecutter example found here.
I follow the instructions verbatim and get the following error when I get to the part where I run visualis

from trame import setup_dev
ImportError: cannot import name 'setup_dev' from 'trame' (C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\li
b\site-packages\trame\__init__.py)

I see the same error regardless of whether I try trame v1 or v2 with the cookiecutter command or whether I choose to upgrade pip or not.

Here is the full traceback:

Traceback (most recent call last):
  File "C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\Scripts\visualis-script.py", line 33, in <module>
    sys.exit(load_entry_point('visualis==1.0.0', 'console_scripts', 'visualis')())
  File "C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\Scripts\visualis-script.py", line 25, in importlib_l
oad_entry_point
    return next(matches).load()
  File "C:\Users\ME\AppData\Local\miniconda3\lib\importlib\metadata\__init__.py", line 171, in load
    module = import_module(match.group('module'))
  File "C:\Users\ME\AppData\Local\miniconda3\lib\importlib\__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\lib\site-packages\visualis\__init__.py", line 1, in
<module>
    from .app import main
  File "C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\lib\site-packages\visualis\app\__init__.py", line 1,
 in <module>
    from .main import main
  File "C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\lib\site-packages\visualis\app\main.py", line 1, in
<module>
    from trame import setup_dev
ImportError: cannot import name 'setup_dev' from 'trame' (C:\Users\ME\KitWare\COOKIECUTTERS_TRAME\cookiecutter-app\.venv\li
b\site-packages\trame\__init__.py)

[staceywhitmore-inl]

I'm mostly a JS developer and haven't used Python's cookiecutter much and this seems like a Python error when it comes to implementing cookiecutter. Just want to make sure I'm doing this right. Any help would be greatly appreciated. Thanks!

[jourdain]

Can you describe what you've done ?

[staceywhitmore-inl]

Yes. I've followed the exact same steps outlined here on the Trame cookiecutter Readme page. verbatim selecting the same choices that were in that provided example (e.g. 1 - App etc. even named it Visualis keeping the same name for package_name and import_name without deviating from the instructions).

Everything goes fine until I get the the end and type my project/package/import name, visualis, and press "enter".

Here are those steps and choices again for quick reference

 python -m venv .venv
 source ./.venv/Scripts/activate
 python -m pip install --upgrade pip
 pip install cookiecutter

 cookiecutter gh:kitware/trame-cookiecutter

    project_name [Trame App]: visualis <-----
    Select project_type:
    1 - App   <-------
    2 - App with Components
    3 - Components
    Choose from 1, 2, 3 [1]:
    author [Trame Developer]: Stacey  <--- (in lieu of 'Kitware' in the original example but this should be of no consequence.)

    short_description [An example Trame application]: VTK viewer for 3d stuff
    Select license:
    1 - BSD License
    2 - MIT License
    3 - ISC License (ISCL)
    4 - Apache Software License
    5 - GNU General Public License v3 (GPLv3)
    6 - Other   <------
    Choose from 1, 2, 3, 4, 5, **6** [1]: 6
    include_continuous_integration [y]: n <------
    package_name [visualis]: visualis  <-----
    import_name [visualis]: visualis  <-----

cd visualis
pip install . # Install your new application

pip install pywebview  # For app usage
pip install jupyterlab # For Jupyter usage

visualis

[staceywhitmore-inl]

I know I said "verbatim"; however, you may notice that I changed the original source ./.venv/bin/activate command to source ./.venv/Scripts/activate but this is only because it appears the version of python I've used to create .venv, version 3.10.13, no longer places the activate script in the bin directory but in the Scripts directory instead.

It's also probably worth noting that I'm using miniconda on Windows and the python3 alias doesn't work on my system so I just substitute python3 -m venv .venv with plain python -m venv .venv but again this should make no difference because prior to running this command I ran python --version which returned 3.10.13 so my python command runs python 3 and not python2. I'm on a Windows 10 machine.

Perhaps I should ask– is there a particular version of Python that seems to work best with setting up the cookiecutter?
(I could try running these steps on a mac or Linux to see if I run into the same issues as well..)

[jourdain]

So I just tried and it is working fine on macOS. Here is the output of my venv

% pip list
Package                   Version
------------------------- --------------
aiohappyeyeballs          2.4.3
aiohttp                   3.10.10
aiosignal                 1.3.1
anyio                     4.6.2.post1
appnope                   0.1.4
argon2-cffi               23.1.0
argon2-cffi-bindings      21.2.0
arrow                     1.3.0
asttokens                 2.4.1
async-lru                 2.0.4
async-timeout             4.0.3
attrs                     24.2.0
babel                     2.16.0
beautifulsoup4            4.12.3
binaryornot               0.4.4
bleach                    6.1.0
bottle                    0.13.2
certifi                   2024.8.30
cffi                      1.17.1
chardet                   5.2.0
charset-normalizer        3.4.0
click                     8.1.7
comm                      0.2.2
cookiecutter              2.6.0
debugpy                   1.8.7
decorator                 5.1.1
defusedxml                0.7.1
exceptiongroup            1.2.2
executing                 2.1.0
fastjsonschema            2.20.0
fqdn                      1.5.1
frozenlist                1.5.0
h11                       0.14.0
httpcore                  1.0.6
httpx                     0.27.2
idna                      3.10
ipykernel                 6.29.5
ipython                   8.28.0
isoduration               20.11.0
jedi                      0.19.1
Jinja2                    3.1.4
json5                     0.9.25
jsonpointer               3.0.0
jsonschema                4.23.0
jsonschema-specifications 2024.10.1
jupyter_client            8.6.3
jupyter_core              5.7.2
jupyter-events            0.10.0
jupyter-lsp               2.2.5
jupyter_server            2.14.2
jupyter_server_terminals  0.5.3
jupyterlab                4.2.5
jupyterlab_pygments       0.3.0
jupyterlab_server         2.27.3
markdown-it-py            3.0.0
MarkupSafe                3.0.2
matplotlib-inline         0.1.7
mdurl                     0.1.2
mistune                   3.0.2
more-itertools            10.5.0
msgpack                   1.1.0
multidict                 6.1.0
nbclient                  0.10.0
nbconvert                 7.16.4
nbformat                  5.10.4
nest-asyncio              1.6.0
notebook_shim             0.2.4
overrides                 7.7.0
packaging                 24.1
pandocfilters             1.5.1
parso                     0.8.4
pexpect                   4.9.0
pip                       24.2
platformdirs              4.3.6
prometheus_client         0.21.0
prompt_toolkit            3.0.48
propcache                 0.2.0
proxy-tools               0.1.0
psutil                    6.1.0
ptyprocess                0.7.0
pure_eval                 0.2.3
pycparser                 2.22
Pygments                  2.18.0
pyobjc-core               10.3.1
pyobjc-framework-Cocoa    10.3.1
pyobjc-framework-Quartz   10.3.1
pyobjc-framework-Security 10.3.1
pyobjc-framework-WebKit   10.3.1
python-dateutil           2.9.0.post0
python-json-logger        2.0.7
python-slugify            8.0.4
pywebview                 5.3.2
PyYAML                    6.0.2
pyzmq                     26.2.0
referencing               0.35.1
requests                  2.32.3
rfc3339-validator         0.1.4
rfc3986-validator         0.1.1
rich                      13.9.3
rpds-py                   0.20.0
Send2Trash                1.8.3
setuptools                69.2.0
six                       1.16.0
sniffio                   1.3.1
soupsieve                 2.6
stack-data                0.6.3
terminado                 0.18.1
text-unidecode            1.3
tinycss2                  1.3.0
tomli                     2.0.2
tornado                   6.4.1
traitlets                 5.14.3
trame                     3.7.0
trame-client              3.4.0
trame-server              3.2.3
trame-vtk                 2.8.11
trame-vuetify             2.7.1
types-python-dateutil     2.9.0.20241003
typing_extensions         4.12.2
uri-template              1.3.0
urllib3                   2.2.3
visualis                  1.0.0
wcwidth                   0.2.13
webcolors                 24.8.0
webencodings              0.5.1
websocket-client          1.8.0
wslink                    2.2.1
yarl                      1.16.0

Ok so you have some error from miniconda and not the venv you've created. Your system seems to be messed up. I can't help with that.

[jourdain]

A google search lead me to that documentation. Maybe that could be useful?

https://learn.microsoft.com/en-us/windows/python/beginners

Maybe you need to manage environments directly in conda?

[staceywhitmore-inl]

Regarding the first link, I already set up my Python environment some time ago so I should be good there. Thanks though. And in regards to Conda's venv, I was thinking the same—I'll just try conda create -n rather than storing my environment variables in the project in a local .venv directory. (Although I feel like I may have tried this already yesterday.. Either way it won't hurt to try again with a specific python version perhaps..) I'll also take a look at package versioning once I create the venv this way and compare them with the versions you posted above. Thanks for sharing those!

And as before, I noticed the activate script from the example is in the /bin/ path so if all else fails, I think I should have some luck trying this in a macOS or Linux environment (e.g. using my WSL install or via Vbox) in keeping with that original example. Between these things I should be able to get it up and working.
Thanks again for your reply!

[staceywhitmore-inl]

OK. I've figured it out. I had a global install of cookiecutter that was polluting my environment vars and overriding any virtual environment I was creating. I deleted the global cookiecutter package, ran through the steps again, did a hot reload to clear my browser cache and now it runs just fine. (I also compared my dependency versions esp. cookiecutter as an additional sanity check so that was helpful. Thanks again for providing that.)