https://github.com/hyperimpose/minutiae
An Erlang application that extends the minutia (https://github.com/hyperimpose/minutia) Python library.
https://github.com/hyperimpose/minutiae
erlang html http hyperimpose link minutia parsing url website
Last synced: 4 months ago
JSON representation
An Erlang application that extends the minutia (https://github.com/hyperimpose/minutia) Python library.
- Host: GitHub
- URL: https://github.com/hyperimpose/minutiae
- Owner: hyperimpose
- License: agpl-3.0
- Created: 2024-09-21T20:44:15.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-08-31T19:59:05.000Z (5 months ago)
- Last Synced: 2025-08-31T21:30:42.019Z (5 months ago)
- Topics: erlang, html, http, hyperimpose, link, minutia, parsing, url, website
- Language: Erlang
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- License: COPYING
Awesome Lists containing this project
README
#+OPTIONS: ^:nil
* minutiae
An Erlang application that extends the [[https://github.com/hyperimpose/minutia][minutia]] Python library.
Extra features:
- A built in cache mechanism.
- Auto-dispatching based on the URL scheme.
When installing minutia the ~media~ extra dependency is included.
** Build
**** Dependencies
To *build* minutiae 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* minutiae you need:
- Python 3.11 or later
- Erlang/OTP 26 or later
**** rebar3
minutiae 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:
#+BEGIN_SRC erlang
{deps, [%% ... Other dependencies
{minutiae, {git, "https://github.com/hyperimpose/minutiae.git", {branch, "master"}}}]}.
#+END_SRC
*** Run
You can quickly build and run minutiae using: ~$ rebar3 shell~.
Then you can run the example found in [[#usage][Usage]]. You can also read the [[./doc/user.org][User documentation]] for more examples and
a complete description of the library.
** Documentation
- [[./doc/user.org][User documentation]] :: API reference, examples, configuration
** Usage
#+BEGIN_SRC erlang
%% After minutiae has been started you can access resources as follows:
minutiae:get("https://hyperimpose.org").
%% The previous call would return the following:
{ok,#{m => http_html, t => <<"hyperimpose">>, explicit => false}}
#+END_SRC
** License
minutiae is licensed under the [[https://www.gnu.org/licenses/agpl-3.0.html][GNU Affero General Public License version 3 (AGPLv3)]].
#+BEGIN_CENTER
[[https://www.gnu.org/graphics/agplv3-with-text-162x68.png]]
#+END_CENTER
A copy of this license is included in the file [[../../COPYING][COPYING]].