Python build succeeds but not added to /bin

[bhq12]

Output of brew config

HOMEBREW_VERSION: 4.1.24-12-gc32bd1c
ORIGIN: https://github.com/Homebrew/brew
HEAD: c32bd1c7cc0c3b1b914845bddfeda53f4d877a3f
Last commit: 33 hours ago
Core tap origin: https://github.com/Homebrew/homebrew-core
Core tap HEAD: e91d0493928e61680eca49c6783491423950d929
Core tap last commit: 5 hours ago
Core tap branch: master
Core tap JSON: 09 Dec 06:37 UTC
HOMEBREW_PREFIX: /opt/homebrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_MAKE_JOBS: 8
HOMEBREW_SORBET_RUNTIME: set
Homebrew Ruby: 3.1.4 => /opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/bin/ruby
CPU: octa-core 64-bit arm_firestorm_icestorm
Clang: 15.0.0 build 1500
Git: 2.43.0 => /opt/homebrew/bin/git
Curl: 8.1.2 => /usr/bin/curl
macOS: 14.1.1-arm64
CLT: 15.0.0.0.1.1694021235
Xcode: 15.0.1
Rosetta 2: false

Output of brew doctor

Please note that these warnings are just used to help the Homebrew maintainers
with debugging if you file an issue. If everything you use Homebrew for is
working fine: please don't worry or file an issue; just ignore this. Thanks!

Warning: Some installed kegs have no formulae!
This means they were either deleted or installed manually.
You should find replacements for the following formulae:
  hello_world
  brook_hello

Warning: Some installed formulae are deprecated or disabled.
You should find replacements for the following formulae:
  [email protected]

Warning: You have unlinked kegs in your Cellar.
Leaving kegs unlinked can lead to build-trouble and cause formulae that depend on
those kegs to fail to run properly once built. Run `brew link` on these:
  hello

Description of issue

Realise this may be as much a "python packaging" question than something brew-specific question but any help would be appreciated (or if there's a better forum please point me that way 👍)

I've started creating a simple CLI tool that I want to publish on my own tap.

I've created a formula

https://github.com/bhq12/homebrew-serviciser/blob/main/serviciser.rb

class Serviciser < Formula
    include Language::Python::Virtualenv
    desc "CLI Tool to initialise new service projects"
    homepage "https://github.com/bhq12/serviciser"
    url "https://github.com/bhq12/serviciser/archive/refs/tags/publish-to-brew20231209T065053.tar.gz"
    sha256 "0280a622028c940ebd305e34cc4d83cc1eec7a1453459bce7dd201fc287b2e78"
    version "v0.0.1"
    depends_on "[email protected]"
    depends_on "pipenv"

    resource "inquirer" do
      url "https://files.pythonhosted.org/packages/78/2f/6c4fd73b82228620025d0042de6dcdc8f32d87557c42ca470d965848d9b5/inquirer-3.1.4.tar.gz"
      sha256 "958dbd5978f173630756a6ed6243acf931e750416eb7a6ed3a0ff13af0fdfcb5"
    end

    resource "blessed" do
      url "https://files.pythonhosted.org/packages/25/ae/92e9968ad23205389ec6bd82e2d4fca3817f1cdef34e10aa8d529ef8b1d7/blessed-1.20.0.tar.gz"
      sha256 "2cdd67f8746e048f00df47a2880f4d6acbcdb399031b604e34ba8f71d5787680"
    end
  
    resource "python-editor" do
      url "https://files.pythonhosted.org/packages/0a/85/78f4a216d28343a67b7397c99825cff336330893f00601443f7c7b2f2234/python-editor-1.0.4.tar.gz"
      sha256 "51fda6bcc5ddbbb7063b2af7509e43bd84bfc32a4ff71349ec7847713882327b"
    end
  
    resource "readchar" do
      url "https://files.pythonhosted.org/packages/a1/57/439aaa28659e66265518232bf4291ae5568aa01cd9e0e0f6f8fe3b300e9e/readchar-4.0.5.tar.gz"
      sha256 "08a456c2d7c1888cde3f4688b542621b676eb38cd6cfed7eb6cb2e2905ddc826"
    end
  
    resource "six" do
      url "https://files.pythonhosted.org/packages/71/39/171f1c67cd00715f190ba0b100d606d440a28c93c7714febeca8b79af85e/six-1.16.0.tar.gz"
      sha256 "1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"
    end
  
    resource "wcwidth" do
      url "https://files.pythonhosted.org/packages/d7/12/63deef355537f290d5282a67bb7bdd165266e4eca93cd556707a325e5a24/wcwidth-0.2.12.tar.gz"
      sha256 "f01c104efdf57971bcb756f054dd58ddec5204dd15fa31d6503ea57947d97c02"
    end

      def install
        virtualenv_install_with_resources
        #bin.install "/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/lib/python3.11/site-packages/cli/cli.py" => "serviciser"
        #chmod "+x", bin/"serviciser"
      end
  end

Which downloads the packaged release from my python project + should package alongside the module dependencies

https://github.com/bhq12/serviciser/tree/main

In the above project I can run simply:

poetry install

and then

poetry run serviciser

And the tool works as expected (some basic prompts + creating a directory)

The pyproject.toml used to package this up looks as so:

[project]
name = 'serviciser'
requires-python = ">=3.9"
version = "1.0.0"

[tool.poetry]
name = "cli"
version = "1.0.0"
description = "CLI tool for initialising new services"
authors = ["bhq12"]
license = "MIT"
readme = "README.md"

[tool.poetry.dependencies]
python = ">=3.10,<3.13"
inquirer = "^3.1.3"
pyinstaller = "^6.2.0"

[tool.setuptools.packages.find]
where = ["."]  # list of folders that contain the packages (["."] by default)
include = ["cli"]  # package names should match these glob patterns (["*"] by default)
exclude = []  # exclude packages matching these glob patterns (empty by default)
namespaces = false  # to disable scanning PEP 420 namespaces (true by default)

[tool.poetry.scripts]
serviciser = "cli.cli:main"

I can see when

brew install serviciser

is run that homebrew is successfully building a package at /opt/homebrew/Cellar/serviciser/v0.0.1

==> Reinstalling bhq12/serviciser/serviciser
==> python3.11 -m venv --system-site-packages --without-pip /opt/homebrew/Cellar/serviciser/v0.0.1/libexec
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--inquirer-20231
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--blessed-202312
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--python-editor-
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--readchar-20231
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--six-20231209-7
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser--wcwidth-202312
==> python3.11 -m pip --python=/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/bin/python install /private/tmp/serviciser-20231209-79878-
🍺  /opt/homebrew/Cellar/serviciser/v0.0.1: 120 files, 814.3KB, built in 9 seconds

 ls /opt/homebrew/Cellar/serviciser/v0.0.1
INSTALL_RECEIPT.json LICENSE              README.md            libexec

But for some reason it isn't linking into /bin/ afterwards.

I was able to fudge a bit by adding the following to the install definition

        #bin.install "/opt/homebrew/Cellar/serviciser/v0.0.1/libexec/lib/python3.11/site-packages/cli/cli.py" => "serviciser"
        #chmod "+x", bin/"serviciser"

But all that does is link up the cli.py file to the serviciser command without any of the dependencies attached, so is clearly not how that's supposed to be done.

Thinking I'm missing something simple to get this install working so if anyone has any ideas would be greatly appreciated

[branchvincent]

Short answer, you're just missing this snippet in your pyproject.toml:

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

---

All brew is doing is installing your package with pip:

$ git clone https://github.com/bhq12/serviciser .
$ python3 -m venv .venv
$ .venv/bin/pip install .
$  cat .venv/bin/serviciser
cat: .venv/bin/serviciser: No such file or directory

So really the problem is pip doesn't currently know about your CLI script. When pip installs a package, it reads a special build-system table in your pyproject.toml to know how to find your package metadata (you can read more about that here). If you omit this, it defaults to setuptools.

Now your pyproject.toml has a mix of metadata for both setuptools and poetry. This isn't necessary (you only need one) and your root issue is your script is defined for poetry but not for setuptools. So your final pyproject.toml can look something like this:

diff --git a/pyproject.toml b/pyproject.toml
index 78a0447..fa1ccea 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,12 +1,8 @@
-[project]
-name = 'serviciser'
-requires-python = ">=3.9"
-version = "1.0.0"
-
 [tool.poetry]
-name = "cli"
+name = "serviciser"
 version = "1.0.0"
 description = "CLI tool for initialising new services"
+packages = [{ include = "cli" }]
 authors = ["bhq12"]
 license = "MIT"
 readme = "README.md"
@@ -16,11 +12,9 @@ python = ">=3.10,<3.13"
 inquirer = "^3.1.3"
 pyinstaller = "^6.2.0"
 
-[tool.setuptools.packages.find]
-where = ["."]  # list of folders that contain the packages (["."] by default)
-include = ["cli"]  # package names should match these glob patterns (["*"] by default)
-exclude = []  # exclude packages matching these glob patterns (empty by default)
-namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
-
 [tool.poetry.scripts]
 serviciser = "cli.cli:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

[bhq12]

Amazing! Thanks @branchvincent

Saved me a lot of wall head-butting there.

Appreciate the research and doc links for detail 🙏

[pacman-admin]

This symlinks it to /usr/bin, I suppose you could do the same for /bin/
It is annoying that brew does this.
sudo ln -s /usr/local/bin/python3 /usr/bin/

Brew flat-out refuses to do anything requiring sudo