Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wall-brew-co/brewtility
A utility library for all of your brewing needs
https://github.com/wall-brew-co/brewtility
beer clojure clojure-library clojurescript-library
Last synced: 3 days ago
JSON representation
A utility library for all of your brewing needs
- Host: GitHub
- URL: https://github.com/wall-brew-co/brewtility
- Owner: Wall-Brew-Co
- License: mit
- Created: 2020-07-19T13:09:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T03:22:01.000Z (9 days ago)
- Last Synced: 2024-11-07T04:25:43.795Z (9 days ago)
- Topics: beer, clojure, clojure-library, clojurescript-library
- Language: Clojure
- Homepage:
- Size: 2.08 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# brewtility
[](https://clojars.org/com.wallbrew/brewtility)
[](https://cljdoc.org/d/com.wallbrew/brewtility/CURRENT)
[](https://github.com/Wall-Brew-Co/brewtility/blob/master/LICENSE)
[](https://twitter.com/WallBrew)
A Clojure(Script) utility library for all of your brewing needs.
This repository follows the guidelines and standards of the [Wall Brew Open Source Policy.](https://github.com/Wall-Brew-Co/open-source "Our open source guidelines")
## Installation
A deployed copy of the most recent version of [brewtility can be found on clojars.](https://clojars.org/com.wallbrew/brewtility)
To use it, add the following as a dependency in your project.clj file:
[](com.wallbrew/brewtility)
The next time you build your application, [Leiningen](https://leiningen.org/) or [deps.edn](https://clojure.org/guides/deps_and_cli) should pull it automatically.
Alternatively, you may clone or fork the repository to work with it directly.
## Expectations
This library is designed to work in conjunction with the [common-beer-format.](https://github.com/Wall-Brew-Co/common-beer-format)
The functions within the library make one main assumptions based on that fact:
1. All measurements are expected to be in the [International System of Units](https://en.wikipedia.org/wiki/International_System_of_Units), also known as the modern metric system. Since many brewing applications, especially those based in America, operate on Imperial Measurements, conversion utilities have been provided in the `brewtility.units` namespace.
## Provided Functionality
Below are examples of provided functionality for each namespace.
The library does provide access to other functions, but those primarily exist in support of those outlined here.
- [Calculations](doc/api/calculations.md)
- [Precision](doc/api/precision.md)
- [Predicates](doc/api/predicates.md)
- [Units of Measure](doc/api/units.md)
- [Wrapping](doc/api/wrapping.md)
## Common Patterns
Brewtility follows several conventions and design patterns that result in artifacts available to library consumers.
These are not strictly required for use; however, they provide additional documentation and ease-of-use to those who adopt them.
- [Symbolic Keywords](doc/patterns/symbolic_keywords.md)
## Testing
[doo](https://github.com/bensu/doo), a Leiningen plugin used to run ClojureScript tests in many JS environments, is already in `project.clj`.
[Karma](https://karma-runner.github.io/latest/index.html) is used as the test runner, and is included in `package.json`.
To install Karma, simply install the Node package:
```bash
npm install
```
Then build the application and run the tests:
```bash
lein test-build
```
The tests will also execute on the JVM, to ensure the library is compatible for apps in both deployment environments.
## Contributors
## License
Copyright © [Wall Brew Co](https://wallbrew.com/)
This software is provided for free, public use as outlined in the [MIT License](https://github.com/Wall-Brew-Co/brewtility/blob/master/LICENSE)