Using a Python Package with 'console_scripts' #318

amit-traiana · 2020-05-26T19:08:55Z

Hi,

I have a Python package that generate console script as entry-point. The setup.py looks like so:

entry_points={"console_scripts": ["my_package" = "my_package.cli:main"]}

I would like to call this python command line script from within a gen_rule, but unable to do it just by calling my_package directly. What I currently do, is to install the package with the requirements file, and create a py_binary like so:

    native.py_binary(
          name = "my_package",
          main = "__main__.py",
          srcs = [
              requirement("my_package"),
          ],
       deps = [
              requirement("pyyaml"),
       ],
    )

This works and I can consume the it from within gen_rule, but it feels a bit hacky - especially the part where I need to manually add deps and not use the deps defined in setup.py.

Is there's a better way doing it perhaps?

The text was updated successfully, but these errors were encountered:

amitz · 2020-08-18T12:45:56Z

Seemed to be solved. I'm able to call console script directly from gen_rule (make sure you have the symbolic link in your path).

thundergolfer · 2020-08-31T13:31:06Z

@amitz Are you able to provide an example, and more detail (particularly about "make sure you have the symbolic link...")?

amitz · 2020-08-31T13:56:38Z

Yes, of-course. I'm using pip_import to install my package using requirements.txt file:

my_script==1.0

I then wrap it using a Bazel macro:

def my_macro(name, **kwargs):
    native.genrule(
        name = name,
        srcs = [":infile.xml"],
        outs = ["outfile.xml"],
        cmd = "my_script --infile=$(location :infile.yaml) --outfile=$@",
    )

The my_script "binary" (Bash script calling the Python code) will be installed somewhere. What I missed is that multiple Docker containers will have different places to store that "binary". On some container It was /usr/local/bin on other /usr/.local/bin etc. So instead - I'm running Bazel in the context of a Virtual env - so the "binary" is always installed on the same spot. Make sure this spot is on your PATH.

pstradomski · 2020-08-31T14:25:22Z

This suggests you're not really using the version installed by pip_import, but the external version in your outer virtualenv (or in user instal location)

…

-- Paweł Stradomski

amitz · 2020-08-31T14:30:46Z

Your right - It's also installed it on the outer virtualenv! In that case, seems like there no way to do that properly.

thundergolfer mentioned this issue Jul 17, 2020

package rules should create wrappers around tool entry_points #341

Open

Dec	JAN	Feb
	04
2020	2021	2022

bazelbuild / rules_python

Using a Python Package with 'console_scripts' #318

Using a Python Package with 'console_scripts' #318

amit-traiana commented May 26, 2020

amitz commented Aug 18, 2020

thundergolfer commented Aug 31, 2020

amitz commented Aug 31, 2020

pstradomski commented Aug 31, 2020

amitz commented Aug 31, 2020 •

edited

bazelbuild / rules_python

Using a Python Package with 'console_scripts' #318

Using a Python Package with 'console_scripts' #318

Comments

amit-traiana commented May 26, 2020

amitz commented Aug 18, 2020

thundergolfer commented Aug 31, 2020

amitz commented Aug 31, 2020

pstradomski commented Aug 31, 2020

amitz commented Aug 31, 2020 • edited

amitz commented Aug 31, 2020 •

edited