index.html

<!doctype html>
<html lang="en">

    <head>
        <meta charset="utf-8">

        <title>Libreant: the general purpose media archive manager</title>

        <meta name="description" content="Nasty code for nasty people!">
        <meta name="author" content="Insomnia-lab">

        <meta name="apple-mobile-web-app-capable" content="yes" />
        <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />

        <link rel="stylesheet" href="css/reveal.css">
        <link rel="stylesheet" href="css/theme/sky.css" id="theme">

        <!-- For syntax highlighting -->
        <link rel="stylesheet" href="lib/css/zenburn.css">

        <!-- If the query includes 'print-pdf', use the PDF print sheet -->
        <script>
            document.write( '<link rel="stylesheet" href="css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );
        </script>

        <!--[if lt IE 9]>
        <script src="lib/js/html5shiv.js"></script>
        <![endif]-->
    </head>

    <body>

        <div class="reveal">

            <!-- Any section element inside of this container is displayed as a slide -->
            <div class="slides">

                <section>
                    <h1>Libreant: </h1>
                    <h3>The general purpose media archive manager</h3>
                    <p>
                    <small>For more info:<a href="https://libreant.readthedocs.org/en/latest/">libreant.rtfd.org</a></small>
                    </p>
                    <img src="img/logo_black.png" alt="Logo" style="border-width:0; width:35%; background-color: transparent; box-shadow:0 0 0px">
                </section>

                <section>
                    <section>
                        <h2>Background</h2>
                        <h4>Insomnialab birth</h4>
                        <p>
                        2013: some people began to meet in Rome, in a local squat, inside Sapienza University.
                        There were exciting times and a new hacker space was born.
                        </p><br/>
                        <p>2015:
                        <code class="python">InsomniaLab</code> moves in CSOA Forte Prenestino, after the
                        eviction of the squat.
                        </p><br/>
                        <p>2016: AvANa and InsomniaLab merged</p>
                    </section>

                    <section>
                        <h2>Background<small>Needs</small></h2>
                        <p>
                        In the University squat we contributed to the beginning of a project, called
                        <em>Proprietà Pirata</em>.
                        </p><p>
                        <strong>Goal:</strong> overcome the limits imposed by the copyright enforcement, primarily inside university classes.
                        </p><p>
                        <strong>How?</strong> free sharing of digitized books inside a physical
                        space
                        </p><p>
                        <strong>How to improve?</strong>
                        an <u>easy-to-use and federative software</u>.
                        for infoshops and self-organized places (autonomous libraries, etc.)
                        </p>
                        <p>
                        Places we want to support: <ul>
                            <li>InfoShops, self-managed libraries. Mostly paper books.</li>
                            <li>Pirate Sharing, huge archives of digital books</li>
                        </ul>
                        </p>
                    </section>

                    <section>
                        <h2>Background</h2>
                        <h4>Existing software</h4>
                        <ul>
                            <li class="fragment"><b>Calibre</b><br/><small>desktop application, not well-suited for web managing</small></li>
                            <li class="fragment"><b>Colibrì</b><br/> <small>not ready at the time</small></li>
                            <li class="fragment"><b>PeerLibrary</b><br/> <small>designed specifically for academic papers</small></li>
                        </ul>
                    </section>
                </section>

                <section>
                    <section>
                        <h2>Reinventing the wheel</h2>
                        <h4>Libreant features</h4>
                        <ul>
                            <li class="fragment"><b>Easier</b><br/><small>Than most librarian software</small></li>
                            <li class="fragment"><b>Completely customizable</b><br/><small>(a.k.a. no
                                    disciplinary classification of knowledge). We made as few assumption as possible</small></li>
                            <li class="fragment"><b>Free software for free books</b><br/><small>Collaborative development</small></li>
                            <li class="fragment"><b>Easy and universal access</b><br/><small>Responsive interface, both for user and admin</small></li>
                            <li class="fragment"><b>Quick install and ready to use</b><br/><small></small></li>
                        </ul>
                    </section>

                    <section>
                        <h2>Architecture</h2>
                        <h4>Tools</h4>
                        <ul>
                            <li class="fragment"><strong>Language</strong>:   python</li>
                            <li class="fragment"><strong>Database</strong>:  elasticsearch + fsdb</li>
                            <li class="fragment"><strong>web framework</strong>:  Flask</li>
                        </ul>
                    </section>

                    <section>
                        <h2>Architecture</h2>
                        <h4>How we built it</h4>
                        <ul>
                            <li>Preset/Templating: you define your data structure</li>
                            <li>Multiple interfaces: Web, REST, Command line</li>
                            <li>Full text search</li>
                            <li>Users and groups</li>
                        </ul>
                    </section>


                    <section>
                        <h2>Architecture</h2>
                        <h4>Preset/Templating</h4>
                        <p>Completely free database structure make possible to use libreant for
                           different archive types.
                        <p>
                        <p>
                           However the librarian can use the preset approach to
                           define some standard informations.
                        </p>
                    </section>

                    <section>
                        <h4> Preset/Templating</h4>
                        <p>
                        <pre><code data-trim >
{"id":"narrative",
"description":"narrative book",
"properties": [{ "id": "category",
                 "description": "book format",
                 "required": true,
                 "type": "enum",
                 "values": ["scientific","novel","children"]
               },
               { "id": "title",
                 "description": "a required property",
                 "required": true
               },
               { "id": "actors",
                 "description":"people who contributed to the creation of the work"
               }],
"allow_upload": true}
                        </code></pre>
                        </p>
                        <p class="fragment">
                        We describe a "narrative book" as title+actors+category
                        </p>

                    </section>


                    <section>
                        <h2>Architecture</h2>
                        <h4>Users and groups</h4>
                        <p>It is possible to manage users and define groups
                           level capabilities in order to make some area/operations
                           restricted to a smaller group of person.
                        </p>
                        <br/>
                        <p>Can everyone add/upload books to your library?</p>
                        <p>There is someone that is taking care of reviewing new entries?</p>
                    </section>

                    <section>
                        <h2>Architecture</h2>
                        <h4>Localization</h4>
                        <p>We use Babel to allow for localization.</p>
                        <p>An example can be looked in the html skeletons</p>
                        <pre><code class="hljs html">
        {%trans%}Sorry, no books matching your query{%endtrans%}
                        </code></pre>
                        <p><small><a href=./index.html#/2/2>Back</a></small></p>
                    </section>


                    <section>
                        <h2>Architecture</h2>
                        <h4>Three way interaction</h4>
                        <ul>
                            <li>Web Interface</li>
                            <li>Command line Interface</li>
                            <li>REST API</li>
                        </ul>
                    </section>

                    <section data-markdown>
                        <script type="text/template">
                        ## Architecture
                        #### REST API
```
GET   /api/v1/volumes/<volume-id>
GET   /api/v1/volumes/?q=staceppademinchia&size=2&from=5
POST  /api/v1/volumes/
PUT   /api/v1/volumes/<volume-id>/attachments/<attachments-id>
GET   /api/v1/volumes/<volume-id-id>/attachments/<attachments-id>/file
```
                        #### [Back](./index.html#/2/2)
                        </script>
                    </section>

                    <section>
                        <h2>Architecture</h2>
                        <h4>CLI</h4>
                        <pre><code class="hljs bash">
Usage: libreant [OPTIONS]

  launch libreant daemon

Options:
  --version                       Show the version and exit.
  -s, --settings PATH           file from wich load settings
  -d, --debug                     operate in debug mode
  -p, --port  PORT                port on which daemon will listen
  --address  ADDRESS              address on which daemon will listen
  --fsdb-path  PATH               path used for storing binary files
  --es-indexname  NAME           index name to use for elasticsearch
  --es-hosts  host...             list of elasticsearch nodes to connect to
  --users-db  url                 url of the database used for users managment
  --preset-paths  path...         list of paths where to look for presets
                                  definition
  --agherant-descriptions  url...
                                  list of description urls of nodes to
                                  aggregate
  --dump-settings                 dump current settings and exit
  --help                          Show this message and exit.
                        </code></pre>
                        <p><small><a href=./index.html#/2/2>Back</a></small></p>
                    </section>

                </section>

                    <section>
                        <h2>Architecture</h2>
                        <h4>Full text search</h4>
                        <p>Let's try it! <p>
                    </section>

                <section>
                    <section data-markdown>
                        <script type="text/template">
                            ## The code
                            #### Fork me on github

                            Easy as a fork

                            ```
        git clone https://github.com/insomnia-lab/libreant
                            ```
                        </script>
                    </section>

                    <section data-markdown>
                        <script type="text/template">
                            ## Read the docs!

                            We have been trying also to document appropriately the code!

                            [libreant.rtfd.org](http://libreant.rtfd.org)
                        </script>
                    </section>

                    <section>
                        <h1 style="padding-top: 150px">THANKS</h1>
                    </section>
                </section>
            </div>

        </div>

        <script src="lib/js/head.min.js"></script>
        <script src="js/reveal.min.js"></script>

        <script>

            // Full list of configuration options available here:
            // https://github.com/hakimel/reveal.js#configuration
            Reveal.initialize({
                controls: true,
                progress: true,
                history: true,

                theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
                transition: Reveal.getQueryHash().transition || 'default', // default/cube/page/concave/zoom/linear/none

                // Optional libraries used to extend on reveal.js
                dependencies: [
                    { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
                    { src: 'plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
                    { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
                    { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
                    { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },
                    { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }
                ]
            });

        </script>

    </body>
</html>