# Prairie CLI
Prairie CLI is a command-line interface designed to streamline your PrairieLearn experience. Whether you're a course instructor, a content developer, or just someone looking to explore PrairieLearn, this tool offers utilities to make your journey smoother.
## Features
* Docker Integration: Easily manage PrairieLearn containers with built-in Docker commands.
* Local Course Development: Test and develop your course content locally without the need for external setups.
* Easy Updates: Keep your local PrairieLearn version up-to-date with simple commands.
## Installation
1. Dependencies: Ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
2. (Windows Users): It's recommended to use WSL 2 for optimal performance. Follow the [installation guide](https://learn.microsoft.com/en-us/windows/wsl/install) for WSL 2 and integrate it with Docker as described [here](https://docs.docker.com/desktop/windows/wsl/).
3. Install Prairie CLI: (Installation steps for Prairie CLI would go here)
## Usage
Once installed, you can use the `prairie` command to access all features. Here are some common commands:
* Launch PrairieLearn: `prairie docker launch --course-dir YOUR_COURSE_DIRECTORY`
* Update PrairieLearn: `prairie docker update`
* Check PrairieLearn Status: `prairie docker status`
For a full list of commands and options, use `prairie --help`.
## Contributing
If you'd like to contribute to Prairie CLI, just make a pull request.
## License
This project is licensed [under the LGPLv3 license](https://www.gnu.org/licenses/lgpl-3.0.en.html),
with the understanding that importing a Python modular is similar in spirit to dynamically linking
against it.
- You can use the library/CLI `prairie` in any project, for any purpose,
as long as you provide some acknowledgement to this original project for
use of the library (for open source software, just explicitly including
`prairie` in the dependency such as a `pyproject.toml` or `Pipfile`
is acknowledgement enough for me!).
- If you make improvements to `prairie`, you are required to make those
changes publicly available.
This license is compatible with the license of all the dependencies as
documented in [this project's own `pyproject.toml`](https://github.com/jlumbroso/prairie/blob/master/pyproject.toml#L29-L49).
Raw data
{
"_id": null,
"home_page": "https://github.com/jlumbroso/prairie",
"name": "prairie",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "PrairieLearn,cli",
"author": "J\u00e9r\u00e9mie Lumbroso",
"author_email": "lumbroso@cis.upenn.edu",
"download_url": "https://files.pythonhosted.org/packages/ed/9b/dafbf5d9063fac33f4455af365920a9c653b036b0182e9824f81ec77ec17/prairie-0.0.2.tar.gz",
"platform": null,
"description": "# Prairie CLI\n\nPrairie CLI is a command-line interface designed to streamline your PrairieLearn experience. Whether you're a course instructor, a content developer, or just someone looking to explore PrairieLearn, this tool offers utilities to make your journey smoother.\n\n## Features\n\n* Docker Integration: Easily manage PrairieLearn containers with built-in Docker commands.\n* Local Course Development: Test and develop your course content locally without the need for external setups.\n* Easy Updates: Keep your local PrairieLearn version up-to-date with simple commands.\n\n## Installation\n\n1. Dependencies: Ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.\n2. (Windows Users): It's recommended to use WSL 2 for optimal performance. Follow the [installation guide](https://learn.microsoft.com/en-us/windows/wsl/install) for WSL 2 and integrate it with Docker as described [here](https://docs.docker.com/desktop/windows/wsl/).\n3. Install Prairie CLI: (Installation steps for Prairie CLI would go here)\n\n## Usage\n\nOnce installed, you can use the `prairie` command to access all features. Here are some common commands:\n\n* Launch PrairieLearn: `prairie docker launch --course-dir YOUR_COURSE_DIRECTORY`\n* Update PrairieLearn: `prairie docker update`\n* Check PrairieLearn Status: `prairie docker status`\n\nFor a full list of commands and options, use `prairie --help`.\n\n## Contributing\n\nIf you'd like to contribute to Prairie CLI, just make a pull request.\n\n## License\n\nThis project is licensed [under the LGPLv3 license](https://www.gnu.org/licenses/lgpl-3.0.en.html),\nwith the understanding that importing a Python modular is similar in spirit to dynamically linking\nagainst it.\n\n- You can use the library/CLI `prairie` in any project, for any purpose,\n as long as you provide some acknowledgement to this original project for\n use of the library (for open source software, just explicitly including\n `prairie` in the dependency such as a `pyproject.toml` or `Pipfile`\n is acknowledgement enough for me!).\n\n- If you make improvements to `prairie`, you are required to make those\n changes publicly available.\n\nThis license is compatible with the license of all the dependencies as\ndocumented in [this project's own `pyproject.toml`](https://github.com/jlumbroso/prairie/blob/master/pyproject.toml#L29-L49).\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "`prairie`: the PrairieLearn command line client",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/jlumbroso/prairie",
"Repository": "https://github.com/jlumbroso/prairie"
},
"split_keywords": [
"prairielearn",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd684e99da57dd972eca700880a2b664d8e66e1d643811104ed8f4bfc8499fa3",
"md5": "631d55d03edac29bde0e8bfa4653fa07",
"sha256": "481bcfb306aaf6fc68e16cd504cb94717f61638d981c55a28b4f0e99535f6c0b"
},
"downloads": -1,
"filename": "prairie-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "631d55d03edac29bde0e8bfa4653fa07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 12012,
"upload_time": "2023-09-08T03:49:14",
"upload_time_iso_8601": "2023-09-08T03:49:14.702519Z",
"url": "https://files.pythonhosted.org/packages/cd/68/4e99da57dd972eca700880a2b664d8e66e1d643811104ed8f4bfc8499fa3/prairie-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed9bdafbf5d9063fac33f4455af365920a9c653b036b0182e9824f81ec77ec17",
"md5": "4e860055cd1c2db1d287523b36777b47",
"sha256": "4b521127782f2e21b42b33558d963a98d37e10ae075c12b68aa248fbe5b98dc2"
},
"downloads": -1,
"filename": "prairie-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4e860055cd1c2db1d287523b36777b47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 9390,
"upload_time": "2023-09-08T03:49:16",
"upload_time_iso_8601": "2023-09-08T03:49:16.219501Z",
"url": "https://files.pythonhosted.org/packages/ed/9b/dafbf5d9063fac33f4455af365920a9c653b036b0182e9824f81ec77ec17/prairie-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 03:49:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jlumbroso",
"github_project": "prairie",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "prairie"
}
JSON
