Cannot import python package I built after installing from github

Question

This my first time creating a python package and I am trying to host it on github so I can use it in my code

Its just a simple module with one file, but when I install it with pip install -r requirements.txt the metadata folder is showing up in the site-packages but not my actual module file singleton.py. Hence I cannot do import singleton

My pyproject.toml

[build-system]
requires = [
    "setuptools>=57",
]
build-backend = "setuptools.build_meta"

My setup.cfg

[metadata]
name = singleton
version = 1.0.0
url = https://github.com/syntapy/singleton

[options]
package_dir = 
    =src
packages=find:

[options.packages.find]
where=src

I've tried following the 'using a src/ layout' in the Configuring setup() using setup.cfg files documentation, both with find and with singleton but it doesn't work

What am I doing wrong here?

Thank you in advance for any help

Kefeng91 · Accepted Answer · 2021-09-01 05:00:13Z

1

You should put single Python file in src/singleton/ along with an __init__.py.

The structure is correctly explained in your link:

├── src
│   └── mypackage
│       ├── __init__.py
│       └── mod1.py
├── setup.py
└── setup.cfg

Otherwise, with the old school setup.py (with singleton.py and setup.py in the same folder):

from distutils.core import setup

setup(name='singleton',
    version='1.0.0',
    url='https://github.com/syntapy/singleton',
    py_modules = ['singleton'],
)

edited Sep 1, 2021 at 5:00

answered Sep 1, 2021 at 4:43

Kefeng91

8126 silver badges10 bronze badges

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

2 Comments

wamster Over a year ago

Thank you, I tried that but it still wasn't working. But then I tried to put it in src/singleton/__init__.py and that worked. But do you know of a way to make it so I can just have it in a singleton.py file?

Kefeng91 Over a year ago

I don't know how with setup.cfg, but with setup.py, it's possible. See edited answer.

Collectives™ on Stack Overflow

Cannot import python package I built after installing from github

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related