search

tchellomello / python-ring-doorbell

Python Ring Door Bell is a library written in Python 3 that exposes the Ring.com devices as Python objects.
GNU Lesser General Public License v3.0
541 stars 171 forks source link

pyproject include = ["LICENSE", "CONTRIBUTING.rst"...] #324

Open cpina opened 6 months ago

cpina commented 6 months ago

This is a question.

In the pyproject.toml there is:

include = [
    "LICENSE",
    "CONTRIBUTING.rst",
    "CHANGELOG.rst",
    "scripts/ringcli.py"
]

I haven't done much Python packaging. But for other packages that I've done in Debian: this was never there, and because it's there I need to fix it in the Debian package (else the files go to an unexpected place).

If I install python-ring-doorbell with pip I see:

carles@pinux:~/p$ find . -iname "contributing.rst"
./venv/lib/python3.11/site-packages/CONTRIBUTING.rst
carles@pinux:~/p$

Which does not seem the correct place for CONTRIBUTING.rst (same for the other files).

I suggest to delete the include (I can do a quick PR if needed) to avoid installing those files in site-packages/ (this is using pip), besides making Debian package more standard. Of course, unless there is a good reason to have the include = there (which I might have missed, only seeing what's happening in other packages).

Also, I don't know the best way to include the files in the pip (I can have a look at other packages...) or if they should be in a subdirectory.

Thanks for considering it!

github-actions[bot] commented 2 months ago

There hasn't been any activity on this issue recently. This issue has been automatically marked as stale because of that. It will be closed if no further activity occurs. Please make sure to update to the latest ring_doorbell version and check if that solves the issue. Thank you for your contributions.