`library` folder not included in the source distribution

Open Beginner friendly
#183 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Reproduce the failure with pipx and raven report --format raw, then inspect the package manifest and setuptools configuration for how the library folder is included. Build a source distribution and verify that its archive contains library; confirm the reproduced command no longer reports the missing-folder error.

Written by the indexing model from the issue text.

Description

query-library

Describe the bug
The library folder is not included in the source distribution built and sent to Pypi:

$ tar tf raven_cycode-1.0.9.tar.gz |grep library | wc -l
0

Thus, when installing raven-cycode using pip and the pypi repository, the library folder isn't available and causes certain commands to fail:

$ raven report --format raw 
2024-06-04 14:31:42 | ERROR    | [Errno 2] No such file or directory: 'library'

To Reproduce

$ pipx install raven-cycode
$ raven report --format raw

Expected behavior
The library folder should be shipped in the source distribution by including them in the package's manifest and by instructing setuptools to include package data during installation. To my knowledge, this is possible only by moving the library folder into the source package tree, otherwise it will likely pollute the Python library namespace.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • Fedora 39
  • Python 3.12.3
  • Raven 1.0.9

Additional context
Side note, currently the package used the folder src in the Python package namespace, which is also confusing. I suggest it to be renamed to something like raven if it doesn't conflict with other packages namespaces, at least less likely than src.

Dominant language
Python
Stars
748
Forks
45
No merged PRs in 30d

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.

More from CycodeLabs/raven

All issues in CycodeLabs/raven

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.