# Essay Writer
A minimal Python-based essay writer package for students. Generate comprehensive essays for literally any topic with a simple command or Python script.
---
## Usage
```bash
pip install essay-writer
```
### CLI Usage
```bash
python -m essay_writer --topic "The Solar System"
```
On the first run, the CLI will prompt you to enter your `OPENAI_API_KEY` which will get stored for future use.
Alternatively, you can reset your API key using the following command.
```bash
python -m essay_writer --set-key "your-openai-api-key"
```
You could also request a re-prompt by using the `-r` flag.
```bash
python -m essay_writer -r --topic "The Solar System"
```
### Package Usage
First install the package.
```bash
pip install essay-writer
```
Then, simply import the package and call the `write_essay` method.
```python
from essay_writer import EssayWriter
## If you don't set the OPENAI_API_KEY, it will read the OPENAI_API_KEY variable from your .env file
writer = EssayWriter(keys={"OPENAI_API_KEY": "test-key" })
solar_system_essay = writer.write_essay(topic="The Solar System", format="markdown")
print(solar_system_essay)
```
---
## Motivation and Objectives
- Demonstrate essay writing capabilities using Generative AI and Python Programming.
- Help our students learn Python Programming, improve their understanding of Generative AI, and write better essays.
- Provide a simple, re-usable interface to integrate specialized essay writing capabilities into Generative AI applications.
- Serve as a research tool for researchers, and teachers to study essay generation, software design, and programming techniques to create sophisticated writing applications.
---
## Contributions
We welcome contributions from developers around the globe. The steps to contribute are simple:
- Fork the repository.
- Create a new branch with your changes.
- Submit a PR to this repository.
- Complete the PR review process with our team.
---
## License
Essay Writer is distributed under the MIT License. Refer to the [LICENSE](https://github.com/thehackersplaybook/essay-writer/blob/main/LICENSE) file for full details.
Raw data
{
"_id": null,
"home_page": "https://github.com/AdiPat/essay-writer",
"name": "essay-writer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Aditya Patange (AdiPat)",
"author_email": "contact.adityapatange@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/06/25/d000c7e4b207db1ae52a8189a9d56b72da5a63976767ab940d23b3ac8315/essay_writer-0.0.1.tar.gz",
"platform": null,
"description": "# Essay Writer\n\nA minimal Python-based essay writer package for students. Generate comprehensive essays for literally any topic with a simple command or Python script.\n\n---\n\n## Usage\n\n```bash\npip install essay-writer\n```\n\n### CLI Usage\n\n```bash\npython -m essay_writer --topic \"The Solar System\"\n```\n\nOn the first run, the CLI will prompt you to enter your `OPENAI_API_KEY` which will get stored for future use.\n\nAlternatively, you can reset your API key using the following command.\n\n```bash\npython -m essay_writer --set-key \"your-openai-api-key\"\n```\n\nYou could also request a re-prompt by using the `-r` flag.\n\n```bash\npython -m essay_writer -r --topic \"The Solar System\"\n```\n\n### Package Usage\n\nFirst install the package.\n\n```bash\npip install essay-writer\n```\n\nThen, simply import the package and call the `write_essay` method.\n\n```python\nfrom essay_writer import EssayWriter\n\n## If you don't set the OPENAI_API_KEY, it will read the OPENAI_API_KEY variable from your .env file\nwriter = EssayWriter(keys={\"OPENAI_API_KEY\": \"test-key\" })\n\nsolar_system_essay = writer.write_essay(topic=\"The Solar System\", format=\"markdown\")\n\nprint(solar_system_essay)\n\n```\n\n---\n\n## Motivation and Objectives\n\n- Demonstrate essay writing capabilities using Generative AI and Python Programming.\n- Help our students learn Python Programming, improve their understanding of Generative AI, and write better essays.\n- Provide a simple, re-usable interface to integrate specialized essay writing capabilities into Generative AI applications.\n- Serve as a research tool for researchers, and teachers to study essay generation, software design, and programming techniques to create sophisticated writing applications.\n\n---\n\n## Contributions\n\nWe welcome contributions from developers around the globe. The steps to contribute are simple:\n\n- Fork the repository.\n- Create a new branch with your changes.\n- Submit a PR to this repository.\n- Complete the PR review process with our team.\n\n---\n\n## License\n\nEssay Writer is distributed under the MIT License. Refer to the [LICENSE](https://github.com/thehackersplaybook/essay-writer/blob/main/LICENSE) file for full details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A minimal package for students to generate essays.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/AdiPat/essay-writer"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ed705b0368825ec6b7048887150fe5ed6897c7045769eb9cf121d112ab8cae28",
"md5": "83d7cff37b015f1158374036b0feac37",
"sha256": "f1915d5ce6d6791faaf8182f7c73e80f488c7d98cdc3ac8c2df1aa64edf6a620"
},
"downloads": -1,
"filename": "essay_writer-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83d7cff37b015f1158374036b0feac37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9801,
"upload_time": "2025-02-08T19:17:09",
"upload_time_iso_8601": "2025-02-08T19:17:09.149159Z",
"url": "https://files.pythonhosted.org/packages/ed/70/5b0368825ec6b7048887150fe5ed6897c7045769eb9cf121d112ab8cae28/essay_writer-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0625d000c7e4b207db1ae52a8189a9d56b72da5a63976767ab940d23b3ac8315",
"md5": "db57a59ccac975c37d70e06c23ab9b21",
"sha256": "300f9d6bd1c32fac6b1b37d94f2acf804ae64bebae0d46933b7e28361cd1094c"
},
"downloads": -1,
"filename": "essay_writer-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "db57a59ccac975c37d70e06c23ab9b21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10324,
"upload_time": "2025-02-08T19:17:11",
"upload_time_iso_8601": "2025-02-08T19:17:11.159632Z",
"url": "https://files.pythonhosted.org/packages/06/25/d000c7e4b207db1ae52a8189a9d56b72da5a63976767ab940d23b3ac8315/essay_writer-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 19:17:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AdiPat",
"github_project": "essay-writer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.10.6"
]
]
},
{
"name": "pydantic-settings",
"specs": [
[
"==",
"2.7.1"
]
]
},
{
"name": "pydantic_core",
"specs": [
[
"==",
"2.27.2"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.9.4"
]
]
},
{
"name": "openai",
"specs": [
[
"==",
"1.61.1"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"75.8.0"
]
]
}
],
"lcname": "essay-writer"
}
JSON
