Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmonks/clj-spdx
Clojure wrapper around spdx/Spdx-Java-Library
https://github.com/pmonks/clj-spdx
Last synced: 9 days ago
JSON representation
Clojure wrapper around spdx/Spdx-Java-Library
- Host: GitHub
- URL: https://github.com/pmonks/clj-spdx
- Owner: pmonks
- License: apache-2.0
- Created: 2023-03-30T00:32:48.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-10-22T03:03:30.000Z (15 days ago)
- Last Synced: 2024-10-23T04:36:00.307Z (14 days ago)
- Language: Clojure
- Size: 713 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
| | | |
|---:|:---:|:---:|
| [**release**](https://github.com/pmonks/clj-spdx/tree/release) | [](https://github.com/pmonks/clj-spdx/actions?query=workflow%3ACI+branch%3Arelease) | [](https://github.com/pmonks/clj-spdx/actions?query=workflow%3Adependencies+branch%3Arelease) |
| [**dev**](https://github.com/pmonks/clj-spdx/tree/dev) | [](https://github.com/pmonks/clj-spdx/actions?query=workflow%3ACI+branch%3Adev) | [](https://github.com/pmonks/clj-spdx/actions?query=workflow%3Adependencies+branch%3Adev) |
[](https://clojars.org/com.github.pmonks/clj-spdx/) [](https://github.com/pmonks/clj-spdx/blob/release/LICENSE) [](https://github.com/pmonks/clj-spdx/issues) [](https://pmonks.github.io/clj-spdx/nvd/dependency-check-report.html)
# clj-spdx
A Clojure wrapper around [`Spdx-Java-Library`](https://github.com/spdx/Spdx-Java-Library), plus some bespoke functionality (e.g. custom [SPDX expression](https://spdx.github.io/spdx-spec/v3.0/annexes/SPDX-license-expressions/) parsing).
Note that that library's functionality is being wrapped on-demand by the author based on their needs in other projects, so this wrapper library is not yet comprehensive. Contributions of any kind are warmly welcomed, especially wrapping additional parts of the Java library!
Note also that this project has no official relationship with the [SPDX project](https://spdx.dev/) (who maintain `Spdx-Java-Library`), and this work is in no way associated with, or endorsed by, them.
## Installation
`clj-spdx` is available as a Maven artifact from [Clojars](https://clojars.org/com.github.pmonks/clj-spdx).
### Trying it Out
#### Clojure CLI
```shell
$ clj -Sdeps '{:deps {com.github.pmonks/clj-spdx {:mvn/version "RELEASE"}}}'
```
#### Leiningen
```shell
$ lein try com.github.pmonks/clj-spdx
```
#### deps-try
```shell
$ deps-try com.github.pmonks/clj-spdx
```
### Demo
```clojure
(require '[spdx.licenses :as sl])
; This is optional but can be time consuming, so we run it explicitly to force
; population of the local Spdx-Java-Library cache.
(sl/init!)
(sl/ids)
;=> #{"MulanPSL-1.0" "OPUBL-1.0" "CC-BY-SA-1.0" [and many more]
(require '[spdx.exceptions :as se])
(se/ids)
;=> #{"GCC-exception-2.0-note" "Qwt-exception-1.0" [and many more]
(require '[spdx.matching :as sm])
(def apache-20-text (slurp "https://www.apache.org/licenses/LICENSE-2.0.txt"))
(sm/licenses-within-text apache-20-text)
;=> #{"Apache-2.0"}
(require '[spdx.expressions :as sexp])
(sexp/parse "GPL-2.0+ WITH Classpath-exception-2.0 OR Apache-2.0")
;=> [:or
;=> {:license-id "Apache-2.0"}
;=> {:license-id "GPL-2.0-or-later" :license-exception-id "Classpath-exception-2.0"}]
```
### API Documentation
[API documentation is available here](https://pmonks.github.io/clj-spdx/), or [here on cljdoc](https://cljdoc.org/d/com.github.pmonks/clj-spdx/).
## Contributor Information
[Contributing Guidelines](https://github.com/pmonks/clj-spdx/blob/release/.github/CONTRIBUTING.md)
[Bug Tracker](https://github.com/pmonks/clj-spdx/issues)
[Code of Conduct](https://github.com/pmonks/clj-spdx/blob/release/.github/CODE_OF_CONDUCT.md)
### Developer Workflow
This project uses the [git-flow branching strategy](https://nvie.com/posts/a-successful-git-branching-model/), and the permanent branches are called `release` and `dev`. Any changes to the `release` branch are considered a release and auto-deployed (JARs to Clojars, API docs to GitHub Pages, etc.).
For this reason, **all development must occur either in branch `dev`, or (preferably) in temporary branches off of `dev`.** All PRs from forked repos must also be submitted against `dev`; the `release` branch is **only** updated from `dev` via PRs created by the core development team. All other changes submitted to `release` will be rejected.
### Build Tasks
`clj-spdx` uses [`tools.build`](https://clojure.org/guides/tools_build). You can get a list of available tasks by running:
```
clojure -A:deps -T:build help/doc
```
Of particular interest are:
* `clojure -T:build test` - run the unit tests
* `clojure -T:build lint` - run the linters (clj-kondo and eastwood)
* `clojure -T:build ci` - run the full CI suite (check for outdated dependencies, run the unit tests, run the linters)
* `clojure -T:build install` - build the JAR and install it locally (e.g. so you can test it with downstream code)
Please note that the `release` and `deploy` tasks are restricted to the core development team (and will not function if you run them yourself).
## License
Copyright © 2023 Peter Monks
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)