Help to write my formula

[cromatikap]

Hello,

I would like to distribute my CLI python program.

To build it, I use python -m PyInstaller btw.py. Then the standalone is in dist/btw/. I can move this folder anywhere and call the executable in it from any place. I made a .tar.gz file of this folder and uploaded it on github as a release.

Then I used brew create https://github.com/bidetaggle/btw/archive/refs/tags/1.0.0.tar.gz to generate the Formula. You can see it here: https://github.com/bidetaggle/homebrew-btw/blob/main/Formula/btw.rb

Now if I do brew tap bidetaggle/btw then brew install btw I get this error:

Error: An exception occurred within a child process:
  RuntimeError: /usr/local/opt/tcl-tk not present or broken
Please reinstall tcl-tk. Sorry :(

Is it possible to have some guidance on this? I'm not event sure that I'm tarballing the right thing. I went through the documentation but I'm honestly confused.

Thank you :)

[carlocab]

Do you have tcl-tk installed? What's the output of

brew config
brew doctor
brew info tcl-tk

?

[gromgit]

What does ls -l /usr/local/opt/tcl-tk output?

[cromatikap]

It's not installed on my machine. My program is only a CLI, it never ever needs any GUI library to work. I'd like brew install btwto work straight away.

What about the release btw.tar.gz, is it what the formula expects?

From this tarball, this is how I would install it manually in the system:

$ tar -xzvf btw.tar.gz
$ cp -r btw /usr/local/lib/
$ ln -s /usr/local/lib/btw/btw /usr/local/bin/btw

[gromgit]

It's not installed on my machine.

That's not what the brew info output says:

$ brew info tcl-tk
tcl-tk: stable 8.6.11 (bottled) [keg-only]
Tool Command Language
https://www.tcl-lang.org
/usr/local/Cellar/tcl-tk/8.6.11_1 (3,041 files, 51.6MB)
  Built from source

but it seems like the installation wasn't done properly. To fix this:

brew uninstall --force --ignore-dependencies tcl-tk
brew install tcl-tk

My program is only a CLI, it never ever needs any GUI library to work. I'd like brew install btw to work straight away.

Your formula depends on [email protected], which in turn depends on tcl-tk, so it's not optional, and should have already been installed. In fact, even if [email protected] weren't installed, brew install btw would install it and everything else that [email protected] depends on, including tcl-tk.

What about the release btw.tar.gz, is it what the formula expects?

I'm neither a Python nor a Ruby expert, but as long as it unpacks into something that can be installed with Homebrew's virtualenv_install_with_resources function, it should be fine. You can brew install --debug btw, then if anything goes wrong, you'll be asked if you want to open a shell to see what happened.

[cromatikap]

Thank you for this neat explanation 💯
This fixed the issue with tcl-tk 👍

Now I get this error from the Formula:

==> Installing bidetaggle/btw/btw
Error: An exception occurred within a child process:
  NameError: undefined local variable or method `virtualenv_install_with_resources' for #<Formulary::FormulaNamespaced82b3d0c22a7940cbf78c9b7f59aab13::Btw:0x00007f7f5f9ff070>

Should I import virtualenv_install_with_resources some how?

---

Full debug log here:

$ brew install --debug btw
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/bidetaggle/homebrew-btw/Formula/btw.rb
==> Installing btw from bidetaggle/btw
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/[email protected]
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/pkg-config.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/gdbm.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/mpdecimal.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/[email protected]
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/readline.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/sqlite.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/tcl-tk.rb
/usr/local/Homebrew/Library/Homebrew/brew.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/xz.rb
==> Downloading https://github.com/bidetaggle/btw/archive/refs/tags/1.0.0.tar.gz
/usr/bin/curl --disable --globoff --show-error --user-agent Homebrew/3.0.9-23-g04d1142\ \(Macintosh\;\ Intel\ Mac\ OS\ X\ 10.15.7\)\ curl/7.64.1 --header Accept-Language:\ en --retry 3 --location --silent --head --request GET https://github.com/bidetaggle/btw/archive/refs/tags/1.0.0.tar.gz
Already downloaded: /Users/bidetaggle/Library/Caches/Homebrew/downloads/76da7489b3d393afa7439be3f116598e81a576468595afca737173dbb8240c19--btw-1.0.0.tar.gz
Warning: A newer Command Line Tools release is available.
Update them from Software Update in System Preferences or run:
  softwareupdate --all --install --force

If that doesn't show you any updates, run:
  sudo rm -rf /Library/Developer/CommandLineTools
  sudo xcode-select --install

Alternatively, manually download them from:
  https://developer.apple.com/download/more/.

/usr/local/Homebrew/Library/Homebrew/shims/scm/git --version
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/[email protected]
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/gdbm.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/mpdecimal.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/[email protected]
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/readline.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/sqlite.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/tcl-tk.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/xz.rb
/usr/local/Homebrew/Library/Homebrew/build.rb (Formulary::FormulaLoader): loading /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/pkg-config.rb
tar xof /Users/bidetaggle/Library/Caches/Homebrew/downloads/76da7489b3d393afa7439be3f116598e81a576468595afca737173dbb8240c19--btw-1.0.0.tar.gz -C /private/tmp/d20210325-35302-jukqvs
cp -pR /private/tmp/d20210325-35302-jukqvs/btw-1.0.0/. /private/tmp/btw-20210325-35302-k57fwa/btw-1.0.0
/usr/local/Homebrew/Library/Taps/bidetaggle/homebrew-btw/Formula/btw.rb:11:in `install'
NoMethodError: undefined method `virtualenv_install_with_resources' for #<Formulary::FormulaNamespaced82b3d0c22a7940cbf78c9b7f59aab13::Btw:0x00007fa87b1ad058>
1. raise
2. backtrace
3. shell
Choose an action: 2
/usr/local/Homebrew/Library/Taps/bidetaggle/homebrew-btw/Formula/btw.rb:11:in `install'
/usr/local/Homebrew/Library/Homebrew/debrew.rb:30:in `block in install'
/usr/local/Homebrew/Library/Homebrew/debrew.rb:104:in `debrew'
/usr/local/Homebrew/Library/Homebrew/debrew.rb:30:in `install'
/usr/local/Homebrew/Library/Homebrew/build.rb:175:in `block (2 levels) in install'
/usr/local/Homebrew/Library/Homebrew/formula.rb:1241:in `block in brew'
/usr/local/Homebrew/Library/Homebrew/formula.rb:2284:in `block (2 levels) in stage'
/usr/local/Homebrew/Library/Homebrew/utils.rb:550:in `with_env'
/usr/local/Homebrew/Library/Homebrew/formula.rb:2283:in `block in stage'
/usr/local/Homebrew/Library/Homebrew/resource.rb:121:in `block (2 levels) in unpack'
/usr/local/Homebrew/Library/Homebrew/download_strategy.rb:100:in `chdir'
/usr/local/Homebrew/Library/Homebrew/download_strategy.rb:100:in `chdir'
/usr/local/Homebrew/Library/Homebrew/download_strategy.rb:87:in `stage'
/usr/local/Homebrew/Library/Homebrew/resource.rb:117:in `block in unpack'
/usr/local/Homebrew/Library/Homebrew/mktemp.rb:63:in `block in run'
/usr/local/Homebrew/Library/Homebrew/mktemp.rb:63:in `chdir'
/usr/local/Homebrew/Library/Homebrew/mktemp.rb:63:in `run'
/usr/local/Homebrew/Library/Homebrew/resource.rb:198:in `mktemp'
/usr/local/Homebrew/Library/Homebrew/resource.rb:116:in `unpack'
/usr/local/Homebrew/Library/Homebrew/resource.rb:91:in `stage'
/usr/local/Homebrew/Library/Homebrew/vendor/portable-ruby/2.6.3_2/lib/ruby/2.6.0/forwardable.rb:230:in `stage'
/usr/local/Homebrew/Library/Homebrew/formula.rb:2263:in `stage'
/usr/local/Homebrew/Library/Homebrew/formula.rb:1234:in `brew'
/usr/local/Homebrew/Library/Homebrew/build.rb:139:in `block in install'
/usr/local/Homebrew/Library/Homebrew/utils.rb:550:in `with_env'
/usr/local/Homebrew/Library/Homebrew/build.rb:134:in `install'
/usr/local/Homebrew/Library/Homebrew/build.rb:227:in `<main>'

[gromgit]

I'm guessing you forgot to add:

include Language::Python::Virtualenv

at the top of your formula definition. For a worked example, see https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/q.rb