Manual installation of Python package

Question

I wrote a small python program and now I want to install and use it on my system.

Program structure:

projectname
|--src
|  |--main.py #import file1
|  |--file1.py #import file2
|  |--file2.py
|--LICENSE
|--README.md
|--setup.py

I did sudo python setup.py install, but now I only able to run it with /usr/bin/main.py. What should I do, to be able to run it by only typing a projectname?

EDIT: Setup.py content:

setuptools.setup(
    name="projectname",
    version="0.0.1",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    entry_points={
        "console_scripts": [
            "projectname = projectname.src/main:main"
        ]
    },
    python_requires='>=3.6',
)

Make a script...

dan1st
– dan1st

2020-07-02 11:47:03 +00:00
Commented Jul 2, 2020 at 11:47 — dan1st
– dan1st, Commented Jul 2, 2020 at 11:47
Make an alias on your machine?

Paolo
– Paolo

2020-07-02 11:48:20 +00:00
Commented Jul 2, 2020 at 11:48 — Paolo
– Paolo, Commented Jul 2, 2020 at 11:48

orestisf · Accepted Answer · 2020-07-02 13:08:57Z

1

You can use setuptools' entry points in your setup.py.

Example from the documentation:

setup(
    # other arguments here...
    entry_points={
        "console_scripts": [
            "foo = my_package.some_module:main_func",
            "bar = other_module:some_func",
        ],
        "gui_scripts": [
            "baz = my_package_gui:start_func",
        ]
    }
)

With your structure, create file src/__init__.py:

from . import main

and lets say that this is src/main.py:

def main():
    print("Hello world")

Finally, setup.py can be:

import setuptools

setuptools.setup(
    name="projectname",
    version="0.0.1",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    entry_points={
        "console_scripts": [
            "projectname = src:main.main"
        ]
    },
    python_requires='>=3.6',
)

edited Jul 2, 2020 at 13:08

answered Jul 2, 2020 at 11:51

orestisf

1,4721 gold badge17 silver badges30 bronze badges

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

4 Comments

Arden Over a year ago

So how should it be in my case? projectname = projectname.src/main:main gives me an error. I am a little unfamiliar with the syntax.

orestisf Over a year ago

@Arden Can you please add the contents of setup.py to your original question?

Arden Over a year ago

I have a main function in the main file and also if __name__ == '__main__': curses.wrapper(main), if that is important.

orestisf Over a year ago

@Arden First, you need to create file src/__init__.py with contents from . import main. Then, the setup line becomes "projectname = src:main.main". Also see github.com/pypa/sampleproject/blob/master/setup.py for an extensive example of a project. I would also advise you to rename the src folder because this is the module name.

Collectives™ on Stack Overflow

Manual installation of Python package

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related