We Keep Coding

how make python command line apps accessible globally?

I wrote a command-line app using python.
the problem is I want the to user can use the command globally after installed the command-line .
I wrote the command-line, I published the package but I don't know how to make this package globally available for users as system commands.
Example :
pip install forosi
and after that user can globally run this command from everywhere they want . like :
forosi help

I'm going to assume you have the main file you are supposed to run in src/forosi.py in your package directory, but you should be able to adapt this if it's different.
First, you want to rename the script to forosi, without the .py extension.
Second, at the top of the file (now called forosi) add the following:
#!/usr/bin/env python3
... rest of file...
In your setup.py for the package, you need to use the scripts option.
setuptools.setup(
...
scripts=['src/forosi'],
...
)
This is the method that required minimal refactoring of your code. If you happen to have a main() function in one of your python files which is the entrypoint of the script, you can just add the following into your setup.py instead of the above:
setup(
...
entry_points = {
'console_scripts': ['src.forosi:main'],
}
...
)
In either case, to build the package locally, run
python3 setup.py bdist_wheel
This will create a wheel file in the dist/ directory called package_name-version-<info>-.whl. This is the official distribution for pypi packages.
To install this package, run:
pip3 install dist/package_name-version-<info>-.whl
or if you only have one version in the dist folder, just
pip3 install dist/*

setup.py installing package and script - NameError referencing package from script

I'm struggling with my first Python package + script project using setuptools. Here's a skeleton of my setup.py:
setuptools.setup(
name=<PROJECT>,
packages=[<PACKAGE_NAME>],
scripts=['bin/<PACKAGE_NAME>.py'],
python_requires='>=3',
)
My package is in package_name/ and my script, which has the same base name as the package, is in bin/package_name.py. The script does from package_name import *. There are no dependencies.
When I run python3 setup.py install, it succeeds. Thereafter, when I do import package_name in a Python console, it succeeds. But when I run the script from the command line, it fails with a NameError on the first reference to a component from the package. I've reproduced the same error on Mac OS X and Linux.
Why does it fail this way, but doesn't throw an ImportError? How can I fix my script or my setup.py?

has the same base name as the package
That's exactly the problem. When you run package_name.py and the script imports package_name Python tries to import it from that script because it's the first package_name.py in sys.path (Python automatically prepends script's directory to sys.path).
Rename the script to package_name. Or even better create __main__.py in your package and use entry_points:
setup(
…
entry_points={
'console_scripts': [
'package_name = package_name.__main__:main'
]
},
…
)
That way setuptools create the script package_name for you automatically.
See an example in my mimedecode.

How to make globally callable python program?

I wrote a module and created a setup.py to install the module:
from setuptools import setup, find_packages
setup(
name='mymodule',
version='0.1',
packages=find_packages(exclude=['test', 'test.*']),
include_package_data=True,
platforms='any',
install_requires=[
'lxml==3.3.5',
'Pillow==3.0.0',
'requests==2.2.1',
'xmltodict==0.10.1',
'pdfrw==0.2',
'python-dotenv==0.4.0',
'boto==2.39.0'
],
)
In the same module I also wrote a command line interface for the module using getopt. I want to make this command line interface globally available so that any user on the system can do things like:
$ mycliprogram -i inputfile.xml -o outputfile.txt
Does anybody know how I can include mycliprogram.py in setup.py so that anybody on the system can use it from the command line?

I'll quote the documentation:
The first approach is to write your script in a separate file, such as you might write a shell script:
funniest/
funniest/
__init__.py
...
setup.py
bin/
funniest-joke
...
Then we can declare the script in setup() like this:
setup(
...
scripts=['bin/funniest-joke'],
...
)
When we install the package, setuptools will copy the script to our PATH and make it available for general use.:
$ funniest-joke

You can either use console-scripts (as Sergey suggested) or the entry_points parameter in your setup():
entry_points={
'console_scripts': [
'mycliprogram=mymodule:whatever',
],
},
This will create a myclyprogram wrapper, which is accessible via $PATH and it will call whatever in mymodule. So if you install your module via pip or setup.py, you'll be able to call mycliprogram with whatever options you defined directly from the command line prompt.
More information: Command Line Scripts – Python Packaging Tutorial

python create system alias to script

I creating an install script for my python project which installs all the external dependencies I need in order to run properly.
I want to create a system alias named myScript which will be alias for path/to/script/run.py so users could just run it by using myScript command
How can I do it?

If your project has a setup.py script and you're installing your python packages, scripts, and dependencies using setuptools (and you should be), you can use the entry_points feature of setuptools.
setup.py
from setuptools import setup
setup(
# other arguments here...
entry_points={
'console_scripts': [
'myScript = my_package.run:main',
],
},
)
Your project structure should look like this:
setup.py
/my_package
__init__.py
run.py
Your run.py script should have a main() function, which will get run when someone types myScript at the command line. This works regardless of what shell they use or what platform you're on.

In terminal:
gedit ~/.bashrc
then inside .bashrc:
alias myScript ='python path/to/script/run.py'
reload bash, and it should work
To be sure where you are executing your script, to now which file to edit, you can check this with Python:
>>> import platform
>>> platform.system()
'Linux'
>>>
To check if it is Mac:
platform.mac_ver()

Disutils Self Extracting Python Package [duplicate]

how can I make setup.py file for my own script? I have to make my script global.
(add it to /usr/bin) so I could run it from console just type: scriptName arguments.
OS: Linux.
EDIT:
Now my script is installable, but how can i make it global? So that i could run it from console just name typing.

EDIT: This answer deals only with installing executable scripts into /usr/bin. I assume you have basic knowledge on how setup.py files work.
Create your script and place it in your project like this:
yourprojectdir/
setup.py
scripts/
myscript.sh
In your setup.py file do this:
from setuptools import setup
# you may need setuptools instead of distutils
setup(
# basic stuff here
scripts = [
'scripts/myscript.sh'
]
)
Then type
python setup.py install
Basically that's it. There's a chance that your script will land not exactly in /usr/bin, but in some other directory. If this is the case, type
python setup.py install --help
and search for --install-scripts parameter and friends.

I know that this question is quite old, but just in case, I post how I solved the problem for myself, that was wanting to setup a package for PyPI, that, when installing it with pip, would install it as a system package, not just for Python.
setup(
# rest of setup
console_scripts={
'console_scripts': [
'<app> = <package>.<app>:main'
]
},
)
Details