Skip to main content

Article-Assistant

Article Assistant is a comprehensive Python package designed to assist with authoring and reviewing scientific articles. Utilizing advanced AI models from OpenAI, the package offers tools for generating complete articles based on provided topics and descriptions and reviewing existing articles for clarity, accuracy, and overall quality.

Features

  • Authoring: Automatically generate well-structured review articles with sections including Title, Abstract, Introduction, Body, Conclusion, and Sources.
  • Reviewing: Use a multi-agent AI system to review articles. The system includes:
    • SME Reviewer: Reviews the article for technical accuracy and provides detailed feedback.
    • SME Search: Searches the internet for similar articles and provides recommendations based on findings.
    • Lead Reviewer: Summarizes the findings from both SME agents into a single cohesive summary.

Quick Start:

Install the Application:

pip install article-assistant

Author a New Article:

# Set API Key:
api_key = os.getenv('OPENAI_API_KEY')
author = Author(api_key)

# Describe the article:
topic = "quaternary ammonium compounds"
description = "An article of quaternary ammonium compounds and their efficacy"

# Generate the Article:
outline = author.generate_outline(topic, description)
paper_content = author.draft_paper(outline)
author.save_to_word(paper_content, "Drafted_Paper.docx")

Review Existing Article:

# Select files to review:
review = Review()
pdf_path = "path/to/file.pdf"

# Run Review:
results = review.review_article(pdf_path)

# Print the results
print("\nSummary by Lead Reviewer:")
print(results["summary"])

print("\nSME_Reviewer Outputs:")
for output in results["sme_reviewer"]:
    print(output)

print("\nSME_Search Outputs:")
for output in results["sme_search"]:
    print(output)

Metadata

Release files for article-assistant 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for article-assistant 0.1.3
File Size Uploaded Provenance
article_assistant-0.1.3.tar.gz 6.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for article-assistant 0.1.3
File Interpreter ABI Platform
article_assistant-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 13.3 kB

Release files / article_assistant-0.1.3.tar.gz

Download URL article_assistant-0.1.3.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
21409e97df307d998fb658c8de0ab00d02b3b2c9341a31655e5cf7ccd090300b
BLAKE2b-256 checksum
How to use checksums
fc60f71b4ea2a0dc586d8c3f9aa47fcf5613e1a11c624069a6a886b881d5e2bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release files / article_assistant-0.1.3-py3-none-any.whl

Download URL article_assistant-0.1.3-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d77b2891c0ba93480b4c1e5ce055bcc03c324aa06485e847ca34c2e81057cc5
BLAKE2b-256 checksum
How to use checksums
40d7eb6537869d9f8443580665f3e907cbe3d5362b5e3816d989d305b237043b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Security for article-assistant 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page