如何为 python 脚本创建别名，类似于黑色？

Question

I am wondering how to make an entry point to call a python script, similar to black .
eg:
black my_script.py

Say I have a python file called fix_newline.py .

Instead of calling python fix_newline.py path/to/my_script.py in the directory of fix_newline.py , I'd like to assign the name fix_newline to python path/to/fix_newline.py .

The ultimate goal is to call fix_newline from anywhere in my directory tree, as long as I am in the same environment (eg ~/.bash_profile ).

Answer 1

I believe I found a way to make an alias via packaging to PyPI as suggested by @Chris_Rands and link provided by @CharlesDuffy:

setup(
    ...,
    entry_points={"console_scripts": ["realpython=reader.__main__:main"]},
)

The entry_point kwarg in setup function in setup.py should be the trick.

Answer 2

1. Add path/to to your PATH variable .bash_profile . (If you have a lot of scripts, consider installing them in a fixed location like ~/bin/ , so that you don't add a lot of unnecessary directories to your PATH .

2. Make sure you script is executable and has an appropriate shebang.

3. Drop the .py from the script name.

Answer 3

You could also use a Bash alias for this: https://tldp.org/LDP/abs/html/aliases.html

Make sure you use absolute path to python and fix_newline.py on your machine:

alias fix_newline='/path/to/your/python /path/to/fix_newline.py'

Then you can use with:

fix_newline file.txt

If you want this alias to be permanent make sure to put this configuration in you ~/.bashrc file: https://tldp.org/LDP/abs/html/sample-bashrc.html