Skip to main content

Générateur de tableau « clause à clause » à partir de l’API d’hypothesis

Project description

Clauseur : extraction d'annotations depuis hypothesis

Attention, c'est un PoC

Installation

python3 -m venv venv
pip install clauseur

# variables d'environnement:
# * soit exporter HYPOTHESIS_{USERNAME,PASSWORD,TOKEN}
# * soit copier https://gitlab.anybox.cloud/rboyer/clauseur/blob/master/.env.tpl 
#   le renommer .env et renseigner les variables

Usage

en ligne de commande

# clauseur --help pour le détail
clauseur https://hypothes.is/groups/9Je32V26/testanybot
# filtrer par tag
clauseur --tag tag1 --tag tag2 https://hypothes.is/groups/9Je32V26/testanybot
# mode verbeux
clauseur --debug https://hypothes.is/groups/9Je32V26/testanybot

en tant que librairie

from clauseur.extract import join_group, get_annotations, leave_group, format_as_markdown_table

group = join_group(url)
annotations = get_annotations(group["id"], ["tag1", "tag2"])
leave_group(group["id"])
tables = format_as_markdown_table(annotations)

Exemple de retour

  • un tableau par document dans le groupe
  • en titre : le nom du fichier utilisé cité
  • colonne Citation: le texte surligné
  • colonne Commentaire: l'annotation
# Piloter-Prestashop-avec-OpenERP.pdf

Citation | Commentaire
---------|------------
OpenERP  | devenu Odoo

autredoc.pdf

Citation Commentaire
Abc Def

# Historique des modifications

## Version actuelle

### Correctifs

* Décompte tags uniques.


## 0.7.0 (2019-05-11)

### Nouveautés

* Ajout des tags & dates sur les annotations.


## 0.6.1 (2019-04-25)

### Nouveautés

* --version sur cli.


## 0.6.0 (2019-04-24)

### Nouveautés

* Assainissement des annotations.

### Changements

* Amélioration documentation usage cli / librairie.


## 0.4.1 (2019-04-23)

### Correctifs

* Meilleure gestion des erreurs argparse.


## 0.4.0 (2019-04-23)

### Nouveautés

* Modèle d'app flask pour répondre à un appel type slashcommand.

* Découplage cli / librairie.


## 0.3.1 (2019-04-23)

### Changements

* Documenter l'installation via pip.

### Correctifs

* Descriptif pypi.


## 0.3.0 (2019-04-22)

### Nouveautés

* Release auto sur pypi.

* Filtre par tag(s)

### Changements

* Génère un tableau par fichier.

### Correctifs

* Ajout licence.


## 0.2.0 (2019-04-22)

### Nouveautés

* CI.

* Variables d'environnement dans .env.

### Changements

* Simplification de l'api.


## 0.1.0 (2019-04-19)

### Nouveautés

* Initialisation package.

* Prototype.

### Autres

* Imp: pkg: gitchangelog pour générer le changelog.

* Imp: requirements avec pip-tools.




Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for clauseur, version 0.7.1
Filename, size File type Python version Upload date Hashes
Filename, size clauseur-0.7.1-py3-none-any.whl (7.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size clauseur-0.7.1.tar.gz (6.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page