Add missing Hatch metadata configuration for direct references (#248)

* Add missing Hatch metadata configuration for direct references

- Add `[tool.hatch.metadata] allow-direct-references = true` to both hatch example projects
- Update documentation in main README and example READMEs to include the required configuration
- This is necessary for Hatchling to handle VCS URLs, local paths, and other direct reference formats supported by UniDep

* Add explanatory comments to Hatch configuration sections in README

- Add comment explaining allow-direct-references purpose
- Add comment explaining the UniDep metadata hook registration

Author: basnijholt

README.md

@@ -438,6 +438,11 @@ dynamic = ["dependencies"]
 [tool.hatch]
 # Additional Hatch configurations
 
+# Allow VCS URLs, local paths, and other direct references in dependencies
+[tool.hatch.metadata]
+allow-direct-references = true
+
+# Register UniDep as a metadata hook to process dependencies
 [tool.hatch.metadata.hooks.unidep]
 ```
 

example/hatch2_project/README.md

@@ -23,6 +23,9 @@ dynamic = ["dependencies"]  # add "dependencies" here
 [tool.hatch]
 # Additional Hatch configurations
 
+[tool.hatch.metadata]
+allow-direct-references = true  # allow VCS URLs, local paths, etc.
+
 [tool.hatch.metadata.hooks.unidep]  # add this to enable the hook
 
 # Specify pip and conda dependencies here

example/hatch2_project/pyproject.toml

@@ -14,6 +14,10 @@ version = "0.1.0"
 
 [tool.hatch]
 
+# Allow direct references (e.g., VCS URLs, local paths) in dependencies
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.hatch.metadata.hooks.unidep]
 
 [tool.unidep]

example/hatch_project/README.md

@@ -23,6 +23,9 @@ dynamic = ["dependencies"]  # add "dependencies" here
 [tool.hatch]
 # Additional Hatch configurations
 
+[tool.hatch.metadata]
+allow-direct-references = true  # allow VCS URLs, local paths, etc.
+
 [tool.hatch.metadata.hooks.unidep]  # add this to enable the hook
 ```
 

example/hatch_project/pyproject.toml

@@ -14,4 +14,8 @@ version = "0.1.0"
 
 [tool.hatch]
 
+# Allow direct references (e.g., VCS URLs, local paths) in dependencies
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.hatch.metadata.hooks.unidep]