scipp / scipp/ess

PEP794: Add import names to project config

Open
#558 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

PEP794 introduces a way to list which modules are installed with a package. This directly applies to ess* because our package names on pypi do not match our import names. I think it works like this: e.g., for ESSsans, we would define

[project]
name = "esssans"
import-names = ["ess.isissans", "ess.loki", "ess.sans"]
import-namespaces = ["ess"]

This is supposed to help tools understand your dependencies. I am not aware of any tool using it yet, but it may still be good to implement.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the project configuration that defines the package metadata for the ess* distributions, then compare the existing names with the PEP 794 example in the issue. Add the appropriate import-names and import-namespaces metadata for the package, and verify that the resulting configuration is accepted by the project’s packaging checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.