📝 paper-editor

A lightweight tool for editing and refining scientific paper drafts using the OpenAI GPT API.
This script helps researchers improve clarity, consistency, and structure across sections such as Abstract, Introduction, Results, and Discussion.

---

🚀 Features

• Automatically edits key sections of scientific papers
• Enhances grammar, tone, and structure using GPT
• Loads API key securely from a local file
• Fully reproducible via Conda environment

---

⚙️ Setup Instructions

1. Clone the repository

git clone git@github.com:Faezov/paper-editor.git
cd paper-editor

2. Create and activate the Conda environment

conda env create -f environment.yml
conda activate openai

3. Add your OpenAI API key

echo "sk-..." > config/open.key

🔒 Your key is ignored by Git via .gitignore.

4. Configure editing rules

Edit the file:

config/rules.json

To adjust prompt instructions, formatting behaviors, or section-specific handling.

---

▶️ Run Example

(openai) python gpt-editor.py <your_paper_google_doc_id>

Output:

gpt-edited.json

(Replace <your_paper_google_doc_id> with the actual document ID.)

---

🔐 Security Notes

• API keys are never tracked in version control.
• Store them locally in config/open.key.
• Rotate your key if you suspect exposure.

---

🧪 Dependencies

• Python (via Conda)
• OpenAI Python SDK
• requests
• python-docx (optional for DOCX support)
• JupyterLab (for notebook workflows)

See environment.yml for full details.

---

📄 License

MIT License

---

🤝 Contributions

Feel free to submit issues or pull requests. All suggestions welcome!