A Homebrew Tap to host UMIACS packages that do not meet the Acceptable Formulae specification due to project age on GitHub or popularity.
Table of Contents
Once Homebrew is installed,
brew tap UMIACS/umiacsto add the UMIACS tap to your Homebrew. If you no longer want to get updated UMIACS tap formulae:
brew untap UMIACS/umiacsPlease note that this will not remove any installed packages. To accomplish that you should run
brew rm $PACKAGE_NAMEWhen ready to install a formula from the UMIACS tap, prepend the
formula name with UMIACS/umiacs. For example, to install UMObj
command line tools
for working with
UMIACS object store buckets,
run
brew install UMIACS/umiacs/umobjIf the formula only exists in the UMIACS tap, as is the case for
UMObj, then brew install umobj will suffice.
After the UMIACS tap has been added, running brew update will fetch
any new or outdated formulae from the UMIACS tap, along with the
default Homebrew repository and any other taps you have added.
This tap is maintained to allow users to easily install UMIACS packages with Homebrew on Mac OSX. The Homebrew Acceptable Formulae specification takes some work to meet. However, the largest impediment to getting new Formulae added to the Homebrew repository is the [significance and popularity requirement](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Acce ptable-Formulae.md). Because most UMIACS projects are probably hosted on UMIACS GitLab and only mirrored (at best) on GitHub, it is unlikely that they will garner the number of stars, watchers and forks required by
brew audit --strict --online $PACKAGE_NAMEWithout passing this automated "popularity contest" the very busy Homebrew maintainers would need some other compelling argument to make an exception and let the package in.
However, tools that are useful to others outside of UMIACS are good candidates to be added to the main homebrew repository. Maintainers and authors of these tools should consider mirroring or hosting their projects on GitHub so that they become more visible and can be candidates for addition to the official repository of Homebrew Formulae. Please see the list below of UMIACS projects with Homebrew formulae that are hosted on GitHub, and consider watching and staring them.
Please follow the same
formula guidelines
and
formula cookbook
as posted in Homebrew's documentation. Furthermore, please consult
how to open a Homebrew pull request (and get it merged)
for tips on writing good merge/pull requests and for considerations
should the formula be a candidate to add to the master Homebrew
repository. Of course, some of the eligibility/popularity
requirements will be relaxed, but make sure you formulae are clean,
and contain test do blocks, ideally with meaningful tests. (i.e.,
something better than tool --help or tool --version to test the
the software was installed and is minimally functional.)
To contribute a new formula to this tap, or to update an existing one,
start by
forking this repository
(UMIACS users/staff only). To get up and running you can use the brew create command after learning about it from the Homebrew
documentation.
brew create $URLcreates a Formula stub which is mostly accurate from the package download URL on GitHub. If the package is python based, it is only a candidate for a Homebrew formula if it is a program/app/executable. Libraries and Frameworks should be put up on PyPi instead. If the formula being added is for a Python package, please start by creating a PyPi package, installing the latest version of the package--from PyPi--via:
pip install --upgrade $PACKAGE_NAMEand then use homebrew_python_poet to create a Homebrew formula stub. PyPi-Poet is available on PyPi and can easily be installed with
pip install --upgrade homebrew_pypi_poetOnce both PyPi-poet and your formula are
installed using pip, run
poet -f $YOUR_FORMULA_NAME > $YOUR_FORMULA_NAME.rbto create a Homebrew formula stub for a Python app. For more info on Homebrew and Python, read Homebrew's documentation of the subject.
none