rosinenpicker 0.1.1

A package for picking the juciest text morsels out of a pile of documents.

rosinenpicker

Deutsch

Manual

Welcome to rosinenpicker! This tool is like a magical sieve that helps you find golden nuggets (or "Rosinen") of information within a mountain of documents. It's designed for anyone who needs to extract specific pieces of information without diving deep into the technicalities.

Understanding Key Terms

• Command Line: A text-based interface to operate your computer. Imagine telling your computer exactly what to do by typing in commands.
• YAML: A simple configuration file format used by rosinenpicker to understand your instructions. It's easy to read and write.
• Arguments: Special instructions you provide to rosinenpicker when you start it, telling it where to find its instructions (YAML file) and where to store its findings.

Getting Started

1. Installation: First, let's bring rosinenpicker to your computer. Open your command line and type:

   pip install rosinenpicker
   

2. Running the Program: To launch rosinenpicker, enter the following:

   rosinenpicker -c path/to/your_config.yml -d path/to/your_database.db
   

   Replace path/to/your_config.yml with the actual path to your configuration file, and path/to/your_database.db with where you'd like to save the findings. (If not specified, the configuration and database files are assumed to be config.yml and matches.db in your current directory; also, the database is automatically created if it is not present on your system.)

Creating Your YAML Configuration

Here's a sample configuration to guide rosinenpicker:

title: 'My Document Search'
strategies:
  strategy1:
    processed_directory: '/path/to/documents'
    file_name_pattern: '.*\.pdf'
    file_format: 'pdf'
    terms:
      term1: 'apple pie'
    export_format: 'csv'
    export_path: '/path/to/export.csv'

This tells rosinenpicker to look in /path/to/documents for PDF files containing "apple pie" and save results in a CSV file at /path/to/export.csv. Fur further information, check out the sample configuration file in this repository - the file contains additional comments you may find useful.

Using rosinenpicker

With your config.yml ready, go back to the command line and run rosinenpicker with the -c and -d arguments as shown above.

Help and Options

For a list of commands and options, type:

rosinenpicker -h

This command displays all you need to know to navigate rosinenpicker.

Conclusion

You're all set to explore and extract valuable information with rosinenpicker. Happy information hunting!