minutia

Minutia summarizes the content of various internet services. It uses a URL based interface. Each URL is mapped to a dictionary that contains data about the resource linked, such as its title, its filesize and more.

Build

Dependencies

To build minutia you will need the following:

• A unix-like environment
• Python 3.11 or later
  • venv
  • pip
• Erlang/OTP 26 or later
  • rebar3
• GNU make

To run minutia you only need:

• Python 3.11 or later
• Erlang/OTP 26 or later

rebar3

Minutia is built using rebar3. You can compile it by running: $ rebar3 compile.

or you can include it in your projects as a dependency in rebar.config:

{deps, [%% ... Other dependencies
       {minutia, {git, "https://github.com/hyperimpose/minutia.git", {branch, "master"}}}]}.

Optional features

Minutia comes with a few optional features that can be enabled by specifying the MINUTIA_ENABLE environment variable.

The available options are:

explicit

Use a machine learning model to detect NSFW images. Read the warning in libminutia before enabling this option.

media

Inspect file metadata and content to provide extra information.

You can specify more than one options separated by a comma:

$ MINUTIA_ENABLE=explicit,media rebar3 compile

Run

You can quickly build and run minutia using: $ rebar3 shell. Then you can run the example found in Usage. You can also read the User documentation for more examples and a complete description of the library.

Documentation

User documentation

API reference, examples, configuration

Usage

%% After minutia has been started you can access resources as follows:

minutia:get("https://hyperimpose.org").

%% The previous call would return the following:
{ok,#{m => http_html, t => <<"hyperimpose">>, explicit => false}}

License

minutia is licensed under the GNU Affero General Public License version 3 (AGPLv3).

A copy of this license is included in the file COPYING.