Skip to main content

Platform research framework — search, citations, analysis, export

Project description

iil-researchfw

Platform research framework — async search, citations, analysis, export.

PyPI Python CI

Features

  • Async-first: asyncio.gather() für parallele API-Calls (arXiv, Semantic Scholar, PubMed, OpenAlex)
  • Brave Search: Web-Search via Brave API
  • Citations: APA, MLA, Chicago, Harvard, IEEE, Vancouver + BibTeX/RIS
  • AI Summary: LLM-agnostisch via LLMCallable Protocol
  • Export: Markdown, LaTeX, DOCX
  • Rate Limiting: Token-Bucket per API-Endpoint
  • Retry: tenacity Exponential Backoff

Installation

pip install iil-researchfw
pip install iil-researchfw[export]     # + python-docx, markdown
pip install iil-researchfw[scraping]   # + beautifulsoup4, playwright
pip install iil-researchfw[all]        # alles

Quick Start

import asyncio
from iil_researchfw.search.academic import AcademicSearchService
from iil_researchfw.search.brave import BraveSearchService
from iil_researchfw.citations.formatter import CitationService, CitationStyle

async def main():
    # Academic Search
    academic = AcademicSearchService()
    papers = await academic.search("machine learning transformers", max_results=10)
    for p in papers:
        print(f"{p.title}{p.source}")

    # Web Search
    brave = BraveSearchService(api_key="your-key")  # or BRAVE_API_KEY env var
    results = await brave.search("Python asyncio best practices")

    # Citations
    citations = CitationService()
    citation = await citations.from_doi("10.1145/3290605.3300233")
    print(citation.format(CitationStyle.APA))

asyncio.run(main())

Architecture

See ADR-105.

License

MIT

Project details


Download files

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

Source Distribution

iil_researchfw-0.2.3.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iil_researchfw-0.2.3-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file iil_researchfw-0.2.3.tar.gz.

File metadata

  • Download URL: iil_researchfw-0.2.3.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for iil_researchfw-0.2.3.tar.gz
Algorithm Hash digest
SHA256 a0b621fb5b8c02fea7eac68fe7a79af2642f5ecba47e49a63cb0350e8d797020
MD5 9255565f74351598ad510dd696d2d18f
BLAKE2b-256 b31a0f27b809cefbef737d9e1cceb2905da55fec14d2effc8f600eed76a81b89

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_researchfw-0.2.3.tar.gz:

Publisher: publish.yml on achimdehnert/researchfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iil_researchfw-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: iil_researchfw-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for iil_researchfw-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6296880a22a1f5fbfa63521618123d1ddbf51268dc3b88ecec8074ece3e82cd
MD5 6f11ff84b7c07814aa370eee93c42af2
BLAKE2b-256 67c41a58b41f965cdf99a058565ee6aa952f33af7515d74e29fcb48bf7149974

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_researchfw-0.2.3-py3-none-any.whl:

Publisher: publish.yml on achimdehnert/researchfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page