Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devnote-dev/license
A simple license management library
https://github.com/devnote-dev/license
Last synced: 16 days ago
JSON representation
A simple license management library
- Host: GitHub
- URL: https://github.com/devnote-dev/license
- Owner: devnote-dev
- License: mit
- Created: 2023-08-04T03:50:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-25T23:43:27.000Z (about 1 year ago)
- Last Synced: 2024-05-06T00:04:58.058Z (6 months ago)
- Language: Crystal
- Homepage:
- Size: 65.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# license
A simple shard for using and managing licenses in your Crystal project. All licenses have been made available via the [choosealicense.com repository](https://github.com/github/choosealicense.com) by GitHub and is freely available under the MIT license.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
license:
github: devnote-dev/license
```
2. Run `shards install`
> **Warning**
> This shard only works with Crystal version 1.9.0 and above. This is due to how enum members are parsed from certain string formats.
## Usage
Licenses are loaded at compile time depending on the methods you use. [Click here](/src/licenses/) for the full list of available licenses.
A single license can be loaded using the `License.load` method:
```crystal
require "license"
license = License.load "mit" # case-insensitive!
```
This will return a license instance which contains the license contents as well as metadata about the license such as the title, SPDX identifier, description and more. See [license.cr](/src/license.cr) for available methods.
Multiple licenses can be loaded using the same method, which will return an array of the license instances:
```crystal
licenses = License.load "bsd-2-clause", "bsd-3-clause"
# => [#, #]
```
> **Warning**
> Unknown licenses will cause a compilation error.
You can also get all available licenses at runtime by using the `License.init` method then access them via `License.licenses`:
```crystal
License.init # loads everything at compile time
License.licenses # => [#, ...]
```
If you wish to do this yourself then you can use the `License.load_all` macro method which will return an array of all available licenses.
### Rendering
Licenses can be rendered at compile time or at runtime via the `License.render` macro or `License#render` instance method.
```crystal
# via macro
License.render "mpl-2.0", year: 2023, author: "devnote-dev"
# => "Mozilla Public License Version 2.0 ..."
# via instance method
license = License.load "mpl-2.0"
license.render year: 2023, author: "devnote-dev"
# => "Mozilla Public License Version 2.0 ..."
```
Keep in mind that the `render` macro method can also raise a compile time error like the other macro methods if the license is not found.
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Devonte W](https://github.com/devnote-dev) - creator and maintainer
This repository is managed under the MIT license.
© 2023 devnote-dev