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.6.0.tar.gz (34.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.6.0-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for iil_researchfw-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ee72f3a63ec30c3cda8ce54dc914e469f6c0ad96a57a7ba6db1f2e9efa6a0da9
MD5 efe041dfea8328fd3a6de812b938e7a3
BLAKE2b-256 de1a31fab06176a3c1c06dd4375b488e568de162175cb6491671814f1d615440

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_researchfw-0.6.0.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.6.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for iil_researchfw-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c7cf3904fd3014bc3a438d9a2aed0e1cf4c00cd8449f1f6fcef60515ec49813
MD5 d836d437545936b3c92192c7da3c9489
BLAKE2b-256 6dc1972b6e71abca81fda189b2c1400791c959d8ec81d4f8af1db9287a3b314b

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_researchfw-0.6.0-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