Specify Name & Location of Environments

[cagledw]

I suspect this question will show my naiveté as I am new to packaging projects. I'm playing around with hatch, and I am using hatchling to build & publish my first python package. As best as I can tell, hatch creates & maintains virtual environments completely outside my editable project. On my windows machine that's %USERPROFILE%\AppData\..many-subdirs...\<prjname>\hash#\<prjname>

I would like to keep the virtual environment with the editable project, under: <prjname>\venv. This would put it @ the same dir-level as the source: <prjname>\src\<prjname> and where pyCharm, my dev environment, expects it. It seems like a major hassle to get pyCharm to use the virtual env in %USERPROFILE%\AppData\...many-subdirs-down...

Is there anyway to adapt hatch to handle virtual environments as I desire? If not, is there a better way to think about the virtual environment issue? Hatch appears to solve some of the build\publish\clean\version issues, but the forced location of virtual environments in %USERPROFILE%\AppData seems like a non-starter to me. Any thoughts?

[ofek]

Set the path in the environment config in pyproject.toml to .venv https://hatch.pypa.io/latest/plugins/environment/virtual/#location

If you are using multiple environments then you want to use the second option so it provides a little bit of nesting

[cagledw]

I added this to my project.toml file:

[tool.hatch.envs.venv]
type = "virtual"
path=.\venv

And then executed:
hatch env create

It errors on the "path=..." line.
TOMLDecodeError: Invalid value

I tried multiple different expressions for path. I must be missing something.

[cagledw]

path="./venv" seems to improve things.
Now: Environment default already exists

[ofek]

You must select the venv: https://hatch.pypa.io/latest/environment/#selection

Otherwise if you want you can set path for the default environment and not have to explicitly select the environment name, though of course that will make every inherited environment use the same path which as I mentioned might not be ideal if you have many different ones

[cagledw]

Well I understand better, but I can't control the virtual environment location as I need. I changed %USERPROFILE%/AppData/Local/hatch/config.toml like this:
[dirs.env]
virtual = "."

This resulted in virtual environment to be installed relative to the project root (good). But hatch insists that environments are created in 3-level directory tree:
<pkgname>/hash#/<pkgname>

This is what I was hoping to achieve.

pkgname
├── venv
│ ├── Lib
│ └── Scripts
├── src
│ └── pkgname
│ ├── init.py
│ └── src1.py
│
├── LICENSE.txt
├── README.md
└── pyproject.toml

[ofek]

Please show project configuration and the command that you ran

[cagledw]

The entire project is here:
https://github.com/cagledw/climate_analyzer

From my project root (same dir as LICENSE.txt), I execute:
hatch env create

My hatch config.toml is pasted below:
mode = "local"
project = ""
shell = ""

[dirs]
project = []
python = "isolated"
data = "C:\Users\davidc\AppData\Local\hatch"
cache = "C:\Users\davidc\AppData\Local\hatch\Cache"

[dirs.env]
virtual = "."
[projects]

[publish.index]
repo = "main"

[template]
name = "cagledw"
email = "[email protected]"

[template.licenses]
headers = true
default = [
"MIT",
]

[template.plugins.default]
tests = true
ci = false
src-layout = false

[terminal.styles]
info = "bold"
success = "bold cyan"
error = "bold red"
warning = "bold yellow"
waiting = "bold magenta"
debug = "bold"
spinner = "simpleDotsScrolling"

[ofek]

In https://github.com/cagledw/climate_analyzer/blob/main/pyproject.toml you have:

[tool.hatch.envs.venv]
path="./venv"

Either change that to [tool.hatch.envs.default] or act upon the venv environment e.g. hatch env create venv, hatch run venv:..., etc.

[cagledw]

Perfect!
As always, it makes sense AFTER you see the light.

BTW: I'm having trouble getting dynamic versioning to work.
I'll start a new discussion thread for that one.