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.1.tar.gz (21.0 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.1-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iil_researchfw-0.2.1.tar.gz
  • Upload date:
  • Size: 21.0 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.1.tar.gz
Algorithm Hash digest
SHA256 faef44f9c70e66ff2eb5b06e5189a7de25a1b88be7748c6eb97d4b1f04af34e0
MD5 1d0d044460bcc19e2db5e48ecda703cf
BLAKE2b-256 cb894cb42003e51de08922cac8871addc4a2f721d7c1b773a58efb53b11bd60a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: iil_researchfw-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 22.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 672e1a36b76f3e571cc0a922b4472a5b2c25fa6a49b198dadb60b8798376a736
MD5 b6cefe508bb194c3abc6738bbcea8a5c
BLAKE2b-256 0e7028416b3fc5862dbcdf9d0883e6649e152530943edd93e7d731475ca910aa

See more details on using hashes here.

Provenance

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