Skip to content

Commit

Permalink
Set requirements, formatted config, README
Browse files Browse the repository at this point in the history
  • Loading branch information
duckduckgrayduck committed Sep 19, 2023
1 parent 24eb87b commit b53734f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 124 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,6 @@

[Please see the Add-On documentation](https://github.com/MuckRock/documentcloud-hello-world-addon/wiki/)

# DocumentCloud Hello World Add-On
# DocumentCloud docTR OCR Add-On

This repository contains an example Add-On for DocumentCloud. It is designed
to be copied and modified to allow one to easily write Add-Ons to bring custom
functionality to DocumentCloud. Please use the green "Use this Template"
button to create a new repository instead of forking. This will be easier as
the new Add-On will diverge significantly from this code base.

After copying the template, remember to update this README file to describe
your new Add-On! It is a good idea to leave the link to the Add-On
documentation at the top of the file though.
This repository contains a DocumentCloud Add-On that uses the [docTR](https://github.com/mindee/doctr) to OCR documents.
94 changes: 0 additions & 94 deletions config.example.yaml

This file was deleted.

24 changes: 4 additions & 20 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,10 @@
# The title is the title of your Add-On
title: Hello World
# The description will be shown above the form when activating the Add-On
description: This is an updated simple test add-on
# Top level type should always be object
title: docTR OCR Add-On
description: An Add-On that uses the open source [docTR](https://github.com/mindee/doctr) to OCR your documents.
type: object
# How does this add-on accept documents
# If more than one type is specified, the user will be prompted to choose one
documents:
# By the current search query
- query
# By the currently selected documents
- selected
# Properties are the fields for your form
properties:
# the key is the name of the variable that will be returned to your code
name:
# the title is what will be shown as the form label
title: Name
# a string is text
type: string
# Categories are what type of Add-On this is. Used to sort the Add-On in the Add-On menu.
properties: []
categories:
- file
- extraction
# Acceptable categories are premium, ai, export, bulk, file, monitor, statistical, and extraction.
# You can read more about DocumentCloud Add-On categories here: https://www.documentcloud.org/help/add-ons#types-of-add-ons
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
python-documentcloud==3.6.0
requests
python-doctr[torch]

0 comments on commit b53734f

Please sign in to comment.