orbitz / ocaml-uri Goto Github PK

Uri -- an RFC3986 URI/URL parsing library

This is an OCaml implementation of the RFC3986 specification for parsing URI or URLs.

Installation

Via OPAM

The OPAM package manager can be used to install this library from source.

opam install uri

Locally

You can build the source code locally via the dune build system.

opam install uri --deps-only
eval `opam config env`
dune build
dune runtest

will install the dependencies via OPAM, build the library and then run the tests in the lib_test/ directory.

Usage

Once installed, there are three ocamlfind packages available for your use:

• uri - the base Uri module
• uri.top - the toplevel printers for use with utop
• uri-sexp - provides converters to and from s-expressions (via a Uri_sexp.t type alias)
• uri.services - the Uri_services module that provides the equivalent of services(5)
• uri.services_full - the Uri_services_full module that provides a complete copy of the /etc/services file. This is quite large and normally not needed.

Contact

• Issues: https://github.com/mirage/ocaml-uri/issues
• E-mail: [email protected]
• API Documentation: http://docs.mirage.io/uri/