Issue with Python Package Upload to PyPI - Invalid Directory Structure

Question

I am encountering an issue while uploading my Python package to PyPI. I have followed the standard steps for creating a distribution package using python setup.py sdist and python setup.py bdist_wheel, but the resulting package on PyPI has an unexpected directory structure.

I have a Python project with the following structure:

my_project/
|-- setup.py
|-- my_module/
    |-- __init__.py
    |-- ...

After running python setup.py sdist and python setup.py bdist_wheel, the dist directory contains both a .tar.gz file and a .whl file.

Upon uploading to PyPI using twine upload dist/*, the package is successfully uploaded, but when users download and install it, they find an unexpected directory structure in their site-packages:

site-packages/
|-- my_project-1.0.0.dist-info/
    |-- ...

What should i do?

Edit:

my_project/
|-- setup.py
|-- my_module/
    |-- __init__.py
    |-- screen.py
    |-- test.txt
    |-- my_module/
        |-- dependency_links.txt
        |-- PKG-INFO
        |-- requires.txt
        |-- SOURCES.txt
        |-- top_level.txt
|-- dist/
    |-- my_module-1.1.5-py3-none-any.whl
    |-- my_module-1.1.5.tar.gz
|-- build/
    |-- bdist.win-amd64
    |-- lib/
        |-- __init__.py
        |-- screen.py

site-packages/
|-- my_project-1.0.0.dist-info/
    |-- INSTALLER
    |-- METADATA
    |-- RECORD
    |-- REQUESTED
    |-- top_level.txt
    |-- WHEEL

There's nothing you can do about it - it's part of the process of the installation - packaging.python.org/en/latest/specifications/… — Anya Shenanigans
– Anya Shenanigans, Commented Jan 28, 2024 at 19:04
@AnyaShenanigans There are none of my scripts inside of my project. Is this normal? — FrostDream
– FrostDream, Commented Jan 28, 2024 at 19:08
I'm not understanding the comment - are you saying that the folder structure isn't in your project and you're wondering where it comes from, or are you missing the various .py package files from your package? — Anya Shenanigans
– Anya Shenanigans, Commented Jan 28, 2024 at 19:48
Your code is installed under the my_module directory not in my_project. Former is import package, latter is distribution package. See glossary: packaging.python.org/en/latest/glossary — sinoroc
– sinoroc, Commented Jan 28, 2024 at 19:48
This last edit you made does not bring much useful information. -- I recommend you rewrite the question to show the content of setup.py (no need to write an "edit" paragraph at the end, we can look at the history ourselves). -- I also recommend you study this tutorial thoroughly: packaging.python.org/en/latest/tutorials/packaging-projects — sinoroc
– sinoroc, Commented Jan 28, 2024 at 22:01

FrostDream · Accepted Answer · 2024-01-28 21:56:07Z

-1

I figured it out. I had to include this in my setup.py file:

    package_data={
        'my_module': ['__init__.py', 'screen.py'],
    },

answered Jan 28, 2024 at 21:56

FrostDream

1114 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

sinoroc Over a year ago

That seems like a very incorrect way to go about it.

Collectives™ on Stack Overflow

Issue with Python Package Upload to PyPI - Invalid Directory Structure

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related