DiamondLightSource/dodal

Rename PyPI release to `dodal` rather than `dls-dodal`

Open

#681 opened on Jul 17, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (12 forks)auto 404
Developer Experiencegood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

We have been granted permission to rename the PyPI package to dodal rather than dls-dodal. To prevent issues with pip install dodal and the mismatch between the repository name, common name and the package installer, we should make use of it.

Acceptance Criteria

  • pip install dodal installs this module

Contributor guide

Research direction
Locate the package name definition in setup.cfg or pyproject.toml, update it from 'dls dodal' to 'dodal', and ensure all references (e.g., in imports, documentation) are consistent. Test the install with `pip install .`.
Tech stack
python
Domain
release
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPyPI packaging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75