linode / linode/ansible-specdoc

[Bug]: PyPI package missing requirements.txt

Open Beginner friendly
#45 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
2
Forks
11
PR merge metrics
No merged PRs in 30d

Description

### Expected Behavior

Downloading the package from PyPI should include the requirements.txt file as the included setup.py references this file and crashes without it.

### Actual Behavior

When downloading the latest version (0.0.17) of the package from PyPI, there is no requirements.txt file included. I also checked 0.0.16 and found it missing from that package.

### Steps to Reproduce

1. Download 0.0.17 package from PyPI
2. Extract using method of choice
3. Observe that the requirements.txt file is absent

### Error Output

```
Traceback (most recent call last):
File "/home/.../src/ansible_specdoc-0.0.17/setup.py", line 31, in
install_requires=requirements_path.read_text().splitlines(),
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/pathlib.py", line 1027, in read_text
with self.open(mode='r', encoding=encoding, errors=errors) as f:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/pathlib.py", line 1013, in open
return io.open(self, mode, buffering, encoding, errors, newline)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/home/.../src/ansible_specdoc-0.0.17/requirements.txt'
```

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 inspecting setup.py and the package contents produced for PyPI, then reproduce the download and extraction steps for version 0.0.17. Confirm that requirements.txt is included in the built package and that setup.py no longer fails when the package is installed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.