| Name | joltedmod JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | |
| Summary | JoltEd self-documenting learning module |
| upload_time | 2023-07-05 18:06:42 |
| maintainer | |
| docs_url | None |
| author | Nathan Laundry |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JoltedMod
JoltedMod is a Python package that utilizes OpenAI's chat models to automatically generate Jupyter Notebook or Markdown-based computer science educational materials. This package can be integrated into a frontend application, such as a CLI or API, to serve educational content.
## Features
- Generate Jupyter Notebook or Markdown content based on a given topic
- Highly configurable using tutorial template JSON structure
- Customizable content creator identity and target audience
- Support for GPT-3.5-turbo and other OpenAI models
## Installation
To install JoltedMod, you can use `pip`:
```
pip install jolted_mod
```
## Usage
Here's an example of how to generate a Jupyter Notebook module for a given topic:
```python
import asyncio
from jolted_mod.main import create_notebook_module
topic = "Intro to for loops in Python"
identity = "professor of computer science"
target_audience = "first year computer science students"
is_code = True
model = "gpt-3.5-turbo"
tutorial_content = asyncio.run(create_notebook_module(topic, identity, target_audience, is_code, model))
print(tutorial_content)
```
## Configuration
You can customize the generated content using a JSON template structure that outlines blocks. An example template file can be found in `tutorial_template.json`.
## Development Setup
JoltedMod uses Poetry for project management. To set up a development environment, follow these steps:
1. Install Poetry if you haven't already:
```
curl -sSL https://install.python-poetry.org | python3 -
```
2. Clone the repository:
```
git clone https://github.com/yourusername/jolted_mod.git
cd jolted_mod
```
3. Install dependencies using Poetry:
```
poetry install
```
4. Activate the virtual environment:
```
poetry shell
```
Now you're ready to start contributing to JoltedMod!
## Contributing
If you'd like to contribute to JoltedMod, feel free to fork the repository and submit a pull request.
## License
JoltedMod is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "joltedmod",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Nathan Laundry",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/bb/75/dc0ff908174582105d63241dac683fd72c18c45707c9af5f9ff5e035eead/joltedmod-0.2.4.tar.gz",
"platform": null,
"description": "\n# JoltedMod\n\nJoltedMod is a Python package that utilizes OpenAI's chat models to automatically generate Jupyter Notebook or Markdown-based computer science educational materials. This package can be integrated into a frontend application, such as a CLI or API, to serve educational content.\n\n## Features\n\n- Generate Jupyter Notebook or Markdown content based on a given topic\n- Highly configurable using tutorial template JSON structure\n- Customizable content creator identity and target audience\n- Support for GPT-3.5-turbo and other OpenAI models\n\n\n## Installation\n\nTo install JoltedMod, you can use `pip`:\n\n```\npip install jolted_mod\n```\n\n## Usage\n\nHere's an example of how to generate a Jupyter Notebook module for a given topic:\n\n```python\nimport asyncio\nfrom jolted_mod.main import create_notebook_module\n\ntopic = \"Intro to for loops in Python\"\nidentity = \"professor of computer science\"\ntarget_audience = \"first year computer science students\"\nis_code = True\nmodel = \"gpt-3.5-turbo\"\n\ntutorial_content = asyncio.run(create_notebook_module(topic, identity, target_audience, is_code, model))\n\nprint(tutorial_content)\n```\n\n## Configuration\n\nYou can customize the generated content using a JSON template structure that outlines blocks. An example template file can be found in `tutorial_template.json`.\n\n## Development Setup\n\nJoltedMod uses Poetry for project management. To set up a development environment, follow these steps:\n\n1. Install Poetry if you haven't already:\n\n```\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\n2. Clone the repository:\n\n```\ngit clone https://github.com/yourusername/jolted_mod.git\ncd jolted_mod\n```\n\n3. Install dependencies using Poetry:\n\n```\npoetry install\n```\n\n4. Activate the virtual environment:\n\n```\npoetry shell\n```\n\nNow you're ready to start contributing to JoltedMod!\n\n## Contributing\n\nIf you'd like to contribute to JoltedMod, feel free to fork the repository and submit a pull request.\n\n## License\n\nJoltedMod is licensed under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "JoltEd self-documenting learning module",
"version": "0.2.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f8520df0f92818549b216da33be1689995055a66228016269376b00d2986d86",
"md5": "b6959438faff0f3b2e4e00ad819531a6",
"sha256": "e62bcf47cd1c3b35651215380555d1ead8134ba31c0880a4efd9455845d91b65"
},
"downloads": -1,
"filename": "joltedmod-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b6959438faff0f3b2e4e00ad819531a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 604165,
"upload_time": "2023-07-05T18:06:40",
"upload_time_iso_8601": "2023-07-05T18:06:40.116544Z",
"url": "https://files.pythonhosted.org/packages/0f/85/20df0f92818549b216da33be1689995055a66228016269376b00d2986d86/joltedmod-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb75dc0ff908174582105d63241dac683fd72c18c45707c9af5f9ff5e035eead",
"md5": "8f2320c5e90f7176c756fa1b16e3de8c",
"sha256": "637928d71ba7f64a7c90c0995e2bbe762fb499b32d7d03f524c051a09db6b2a2"
},
"downloads": -1,
"filename": "joltedmod-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "8f2320c5e90f7176c756fa1b16e3de8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 596935,
"upload_time": "2023-07-05T18:06:42",
"upload_time_iso_8601": "2023-07-05T18:06:42.321151Z",
"url": "https://files.pythonhosted.org/packages/bb/75/dc0ff908174582105d63241dac683fd72c18c45707c9af5f9ff5e035eead/joltedmod-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 18:06:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "joltedmod"
}
