https://github.com/diku-dk/smlpkg
Generic package manager for Standard ML libraries and programs
https://github.com/diku-dk/smlpkg
sml smlpkg standard-ml
Last synced: about 1 month ago
JSON representation
Generic package manager for Standard ML libraries and programs
- Host: GitHub
- URL: https://github.com/diku-dk/smlpkg
- Owner: diku-dk
- License: mit
- Created: 2020-03-08T12:44:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-23T13:24:09.000Z (8 months ago)
- Last Synced: 2025-04-13T00:53:18.869Z (6 months ago)
- Topics: sml, smlpkg, standard-ml
- Language: Standard ML
- Size: 87.9 KB
- Stars: 165
- Watchers: 8
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# smlpkg [](https://github.com/diku-dk/smlpkg/actions)
This program constitutes a generic package manager for Standard ML
libraries and programs. The package manager assumes nothing and knows
nothing about the Standard ML compilers used and is thus quite
generic.
The package manager is centered around the notion of [semantic versioning](https://semver.org/) and currently supports packages
hosted on [GitHub](https://github.com/) and
[GitLab](https://about.gitlab.com/).
The package manager takes care of downloading and upgrading dependent
packages and works well with the use of MLB files supported by
Standard ML compilers such as [MLton](http://mlton.org/),
[MLKit](http://elsman.com/mlkit/), and
[SMLtoJs](http://www.smlserver.org/smltojs/).
# Usage
## Adding a package
```
$ smlpkg add github.com/diku-dk/sml-random
```
This command modifies only `sml.pkg` and creates it if it does not already exist.
## Downloading required packages
```
$ smlpkg sync
```
This command populates the `lib` directory based on the packages listed in `sml.pkg`.
## Creating a new package
```
$ smlpkg init github.com/foo/bar
```
This command creates a file `sml.pkg` and initiates it with the given
package name (`foo` should be a github user name or an organisation
name and `bar` should be a repository name). You can now add code in the
directory `lib/github.com/foo/bar/`.
## Releasing a package
```
$ git tag vX.Y.Z
$ git push --tags
```
Remember to follow [semantic versioning](https://semver.org). Once a
package has been released, other packages can safely add the package
to their own source code tree using `smlpkg add` (see above).
## Probably incomplete list of available packages
* [](https://github.com/diku-dk/futhark-data-sml/actions) [github.com/diku-dk/futhark-data-sml](https://github.com/diku-dk/futhark-data-sml)
* [](https://github.com/diku-dk/futhark-server-sml/actions) [github.com/diku-dk/futhark-server-sml](https://github.com/diku-dk/futhark-server-sml)
* [](https://github.com/diku-dk/sml-aplparse/actions)
[github.com/diku-dk/sml-aplparse](https://github.com/diku-dk/sml-aplparse)
* [](https://github.com/diku-dk/sml-base64/actions)
[github.com/diku-dk/sml-base64](https://github.com/diku-dk/sml-base64)
* [](https://github.com/diku-dk/sml-complex/actions)
[github.com/diku-dk/sml-complex](https://github.com/diku-dk/sml-complex)
* [](https://github.com/diku-dk/sml-cstring/actions)
[github.com/diku-dk/sml-cstring](https://github.com/diku-dk/sml-cstring)
* [](https://github.com/diku-dk/sml-hashtable/actions)
[github.com/diku-dk/sml-hashtable](https://github.com/diku-dk/sml-hashtable)
* [](https://github.com/diku-dk/sml-http/actions)
[github.com/diku-dk/sml-http](https://github.com/diku-dk/sml-http)
* [](https://github.com/diku-dk/sml-json/actions)
[github.com/diku-dk/sml-json](https://github.com/diku-dk/sml-json)
* [](https://github.com/diku-dk/sml-matrix/actions)
[github.com/diku-dk/sml-matrix](https://github.com/diku-dk/sml-matrix)
* [](https://github.com/diku-dk/sml-md5/actions)
[github.com/diku-dk/sml-md5](https://github.com/diku-dk/sml-md5)
* [](https://github.com/diku-dk/sml-getopt/actions)
[github.com/diku-dk/sml-getopt](https://github.com/diku-dk/sml-getopt)
* [](https://github.com/diku-dk/sml-parse/actions)
[github.com/diku-dk/sml-parse](https://github.com/diku-dk/sml-parse)
* [](https://github.com/diku-dk/sml-pickle/actions)
[github.com/diku-dk/sml-pickle](https://github.com/diku-dk/sml-pickle)
* [](https://github.com/diku-dk/sml-pretty/actions)
[github.com/diku-dk/sml-pretty](https://github.com/diku-dk/sml-pretty)
* [](https://github.com/diku-dk/sml-regexp/actions)
[github.com/diku-dk/sml-regexp](https://github.com/diku-dk/sml-regexp)
* [](https://github.com/diku-dk/sml-random/actions)
[github.com/diku-dk/sml-random](https://github.com/diku-dk/sml-random)
* [](https://github.com/diku-dk/sml-server/actions)
[github.com/diku-dk/sml-server](https://github.com/diku-dk/sml-server)
* [](https://github.com/diku-dk/sml-setmap/actions)
[github.com/diku-dk/sml-setmap](https://github.com/diku-dk/sml-setmap)
* [](https://github.com/diku-dk/sml-sort/actions)
[github.com/diku-dk/sml-sort](https://github.com/diku-dk/sml-sort)
* [](https://github.com/diku-dk/sml-sha256/actions)
[github.com/diku-dk/sml-sha256](https://github.com/diku-dk/sml-sha256)
* [](https://github.com/diku-dk/sml-sobol/actions)
[github.com/diku-dk/sml-sobol](https://github.com/diku-dk/sml-sobol)
* [](https://github.com/diku-dk/sml-unicode/actions)
[github.com/diku-dk/sml-unicode](https://github.com/diku-dk/sml-unicode)
* [](https://github.com/diku-dk/sml-uref/actions)
[github.com/diku-dk/sml-uref](https://github.com/diku-dk/sml-uref)
* [github.com/pzel/assert-polyml](https://github.com/pzel/assert-polyml)
* [github.com/pzel/sml-either](https://github.com/pzel/sml-either)
* [github.com/pzel/sqlite3-polyml](https://github.com/pzel/sqlite3-polyml)
* [github.com/shwestrick/sml-audio](https://github.com/shwestrick/sml-audio)
* [github.com/shwestrick/sml-uri](https://github.com/shwestrick/sml-uri)
* [github.com/shwestrick/sml-parseq](https://github.com/shwestrick/sml-parseq)
## Design details
See this [blog post on the design of the Futhark package
manager](https://futhark-lang.org/blog/2018-08-03-the-present-futhark-package-manager.html).
# Compilation
To compile the package manager, you need a Standard ML compiler such
as [MLton](http://mlton.org/) or [MLKit](http://elsman.com/mlkit/).
## Compilation using MLKit on macOS
```
$ brew install mlkit
$ make all
```
## Compilation using MLton
```
$ MLCOMP=mlton make clean all
```
# License
This software is distributed under the [MIT LICENSE](LICENSE).
The package manager is almost a complete port of the Futhark
package manager, designed, and implemented in Haskell by Troels
Henriksen.