An open API service indexing awesome lists of open source software.

https://github.com/outscale/homebrew-tap

Outscalehomebrew tap
https://github.com/outscale/homebrew-tap

formulae homebrew tap

Last synced: about 1 month ago
JSON representation

Outscalehomebrew tap

Awesome Lists containing this project

README

          

# Outscale Brew Formulas

[![Project Incubating](https://docs.outscale.com/fr/userguide/_images/Project-Incubating-blue.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html) [![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat\&theme=default-inverted)](https://discord.gg/HUVtY5gT6s)

---

## 🌐 Links

* Documentation: [https://docs.outscale.com/en/](https://docs.outscale.com/en/)
* Tap URL: `outscale/tap`
* Community: Join us on [Discord](https://discord.gg/HUVtY5gT6s)

---

## πŸ“„ Table of Contents

* [Overview](#-overview)
* [Requirements](#-requirements)
* [Installation](#-installation)
* [Usage](#-usage)
* [Maintainers: Updating Python Formulae](#-maintainers-updating-python-formulae)
* [Contributing](#-contributing)
* [License](#-license)

---

## 🧭 Overview

**Outscale Brew Formulas** is the official Homebrew tap for Outscale tools and utilities.
It lets you install Outscale software via `brew` on macOS and Linux.

**Highlights**

* Simple installation with `brew tap outscale/tap`
* Reproducible builds with vendored Python resources
* Central place to discover Outscale CLI tools

---

## βœ… Requirements

* macOS or Linux
* [Homebrew](https://brew.sh/) installed and in your `PATH`
* (Optional) Developer tools for building from source

---

## βš™ Installation

```bash
brew tap outscale/tap
```

You can then install any formula from this tap, for example:

```bash
brew install outscale/tap/
# e.g.
# brew install outscale/tap/oapi-cli
```

---

## πŸš€ Usage

List available formulas from the tap:

```bash
brew search outscale/tap/
```

Upgrade installed formulas:

```bash
brew upgrade outscale/tap/
```

Reinstall from source (useful while developing a formula):

```bash
brew reinstall --build-from-source ./.rb
```

---

## πŸ”§ Maintainers: Updating Python Formulae

When a packaged Python project releases a new version, update the corresponding formula:

1. **Get the new version and file URL on PyPI**

* Go to the project’s page on PyPI (e.g., `https://pypi.org/project///#files`)
* Copy the **source tarball** URL and its **SHA256**.

2. **Edit the formula**

* Update the `url` and `sha256` fields in `./.rb` to match the new PyPI release.

3. **Refresh vendored resources**

* From the repository root, run:

```bash
brew update-python-resources ./oapi-cli.rb
```

Replace `oapi-cli.rb` with the formula you’re maintaining.

4. **Test locally**

```bash
brew reinstall --build-from-source ./oapi-cli.rb
brew audit --new --strict ./oapi-cli.rb
brew test ./oapi-cli.rb
```

5. **Open a PR**

* Include a short changelog and the upstream release link.

---

## πŸ“œ License

**Outscale Brew Formulas** is released under the BSD-3-Clause license.

Β© 2025 Outscale SAS

See [LICENSE](./LICENSE) for full details.

---

## 🀝 Contributing

We welcome contributions!

Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request.