Known dev mode problem

[ubaldot]

Hi all,

I am moving the first steps in building & publishing packages, and I decided to go for hatch, which seems lean and easy - which is the way I like! :)

However, I am hitting into an apparently known problem - and I don't know if it is solved yet.
By running pip install -e . I got the following error

ValueError: Dev mode installations are unsupported when any path rewrite in the sources option changes a prefix rather than removes it, see: https://github.com/pfmoore/editables/issues/20

The issue from the error message seems to still be open, is it correct? Is there any workaround for it?

EDIT: I am running Hatch, version 1.5.0.

[ofek]

No workaround, but your config is likely way more complex than necessary. Please show it and explain what you're try to do.

[ubaldot]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "mypackage"
version = "0.1"
requires-python = ">=3.9"
authors = [
  { name="Ubaldo", email="[email protected]" },
]
description = "mypackage is super cool package."
readme = "README.md"
license = { file="LICENSE" }
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
]
keywords = [
  "data-analysis",
  "modeling",
  "data"
]
# dynamic = ["version"] This may be useful once I will learn how to deal with versions



# =======================
# Hatch settings
# =======================

[tool.hatch.build.targets.sdist]
exclude = [
  "/.github"
]

[tool.hatch.build.targets.wheel]
only-include = ["src/mypackage", "scripts"]

[tool.hatch.build.targets.wheel.sources]
"src" = ""
"scripts" = "mypackage/scripts"


# ===================================
# Formatting, type check, unit-test 
# ===================================
# black
[tool.black]
target-version = ['py39']
line-length = 80
exclude = ["scripts", "docs"]

# mypy
[tool.mypy]
python_version = "3.9"
disallow_untyped_defs = true
show_error_codes = true
no_implicit_optional = true
warn_return_any = true
warn_unused_ignores = true
# For now, mypy is only run on ./src
# The following two shall be module specific
ignore_missing_imports = true
disable_error_code = ["name-defined"]

[[tool.mypy.overrides]]
module = [
    "dataset",
    "validation",
    "utils",
    "config",
]


# pytest
[tool.pytest.ini_options]
norecursedirs = ["scripts"] # Exclude folders

[ofek]

How are they executed after install?

[ubaldot]

The user can choose to open them and there are code-cell blocks with examples on how to use the API.

I sent you the link of the repo. You can see their content. :)

[ofek]

I don't see how they are invoked

[ubaldot]

a user can create a script and run

import dymoval as dmv

dmv.open_tutorial()

So they are not automatically invoked after install.

[ofek]

Can you move scripts/ under src/dymoval/?

[ubaldot]

Well, I could for testing purposes, but I would rather having them in a separate folder.
Well, I have to when we will start the releases…

[ubaldot]

Ok, so I can be safe with the solution found?

[ofek]

Yup!

[ubaldot]

Last question: what if I want to exclude specific files. Is it possible if I use the force-include option?

[ofek]

Yes

[ubaldot]

Ok, it would be nice if you can update the docs. :)
At the moment there are a number of notes under the force-include part and it is not super clear how to exclude files (or paths). :)