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.1.0.tar.gz (19.4 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.1.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iil_researchfw-0.1.0.tar.gz
  • Upload date:
  • Size: 19.4 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.1.0.tar.gz
Algorithm Hash digest
SHA256 fc1251f333b0dbef78ec3af18aa06681d0483d01ac7ebe8230e93f32d4d3e65f
MD5 b2265bc32e53f879e394422618d3a7af
BLAKE2b-256 192fdcee931ac5092cd68ffa3a217ef1c7d6430c2bb61d183be24c003e93bbad

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: iil_researchfw-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.8 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72e80c9c28a7d72556076dcbb10e9437879de5102d8b53a3558b4c3e533b2b00
MD5 eae900fe428417e3db95215fcdf1e361
BLAKE2b-256 6398e99e0a8c73c36a0768ebb8ec933c325d9b48bbe37f60d39f108e8d974c9c

See more details on using hashes here.

Provenance

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