#
<div align="center">
<img width="1072" alt="logo" src="https://user-images.githubusercontent.com/1636709/210475936-9943ee5d-6bec-488d-a309-7a0df2312291.png">
<h1>WiseYoda</h1>
<p>
Quotes from the <a href="https://github.com/Mikaayenson/WiseYoda">Wise Yoda</a>
</p>
<!-- Badges -->
[](https://www.python.org/downloads/)
[](https://github.com/Mikaayenson/WiseYoda/actions/workflows/python-testing.yml)
<h5>
<a href="https://github.com/Mikaayenson/WiseYoda/issues/">Report Bug</a>
<span> ยท </span>
<a href="https://github.com/Mikaayenson/WiseYoda/issues/">Request Feature</a>
</h5>
</div>
<br />
<!-- About the Project -->
## :star2: About the Project
Simple library to obtain wisdom from the wise Master Yoda in the form of quotes. Create a [feature request](https://github.com/Mikaayenson/WiseYoda/issues) if there are some useful features/commands that you hate to remember!
<!-- Screenshots -->
### :camera: Screenshots
<p align="center">
<img width="710" alt="Help" src="https://user-images.githubusercontent.com/1636709/210474079-0fd9c801-d6ba-4c87-8244-41a4c4ba5ed1.png">
<img width="710" alt="Simple" src="https://user-images.githubusercontent.com/1636709/210474075-5ad35761-5765-49e7-ae22-62ff4aec85e1.png">
<img width="710" alt="Complex" src="https://user-images.githubusercontent.com/1636709/210474078-d8c3c528-9bc6-4934-a970-4d372e3202a1.png">
</p>
<!-- Getting Started -->
## :toolbox: Getting Started
<!-- Prerequisites -->
### :bangbang: Prerequisites
This project uses poetry as the python package manager
- `poetry` Follow the [poetry install](https://python-poetry.org/docs/) guide
- `python3.8+` Download from [python](https://www.python.org/downloads/) (ideally `3.10`)
```bash
pip install wiseyoda
```
<!-- Usage -->
## :eyes: Usage
Reminder: These commands must be run in the virtualenv where you installed the dependencies.
```bash
from wise_yoda import Quotes
lesson = Quotes().random_quote()
lesson = Quotes().select_quote(season=1, episode=1)
```
<!-- Run Locally -->
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/Mikaayenson/WiseYoda.git
```
Go to the project directory
```bash
cd wise_yoda
```
Install system and Python dependencies
```bash
make deps
```
Run wiseyoda
```bash
wiseyoda --help
```
<!-- Development -->
### :construction: Development
<div align="center">
<img width="710" alt="makefile" src="https://user-images.githubusercontent.com/1636709/210474182-474a778f-9267-4e7c-84d3-3edb48cc9f8a.png">
</div>
Install pre-commit
```bash
pre-commit install
```
Update Python dependencies
```bash
make deps-py-update
```
<!-- Running Tests -->
### :test_tube: Running Tests
Run tests
```bash
make test
```
Run linter
```bash
make check
```
<!-- Build: Poetry -->
### :triangular_flag_on_post: Build: Python Package
Build this project as a `sdist` and `wheel`
```bash
make build
```
<!-- License -->
## :warning: License
Distributed under the Apache2.0 License. See LICENSE.txt for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/Mikaayenson/WiseYoda",
"name": "wiseyoda",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "Star Wars,Yoda,Quotes",
"author": "Mika Ayenson",
"author_email": "Mika.ayenson@elastic.co",
"download_url": "https://files.pythonhosted.org/packages/9d/49/1f6a9f20a90399bfaa2bd726204d6b3dcf12ae8a4319d12a9bd450bd1066/wiseyoda-1.0.1.tar.gz",
"platform": null,
"description": "#\n\n<div align=\"center\">\n <img width=\"1072\" alt=\"logo\" src=\"https://user-images.githubusercontent.com/1636709/210475936-9943ee5d-6bec-488d-a309-7a0df2312291.png\">\n <h1>WiseYoda</h1>\n\n <p>\n Quotes from the <a href=\"https://github.com/Mikaayenson/WiseYoda\">Wise Yoda</a>\n </p>\n\n\n<!-- Badges -->\n\n[](https://www.python.org/downloads/)\n[](https://github.com/Mikaayenson/WiseYoda/actions/workflows/python-testing.yml)\n\n<h5>\n <a href=\"https://github.com/Mikaayenson/WiseYoda/issues/\">Report Bug</a>\n <span> \u00b7 </span>\n <a href=\"https://github.com/Mikaayenson/WiseYoda/issues/\">Request Feature</a>\n </h5>\n</div>\n\n<br />\n\n<!-- About the Project -->\n## :star2: About the Project\n\nSimple library to obtain wisdom from the wise Master Yoda in the form of quotes. Create a [feature request](https://github.com/Mikaayenson/WiseYoda/issues) if there are some useful features/commands that you hate to remember!\n\n<!-- Screenshots -->\n### :camera: Screenshots\n\n<p align=\"center\">\n<img width=\"710\" alt=\"Help\" src=\"https://user-images.githubusercontent.com/1636709/210474079-0fd9c801-d6ba-4c87-8244-41a4c4ba5ed1.png\">\n<img width=\"710\" alt=\"Simple\" src=\"https://user-images.githubusercontent.com/1636709/210474075-5ad35761-5765-49e7-ae22-62ff4aec85e1.png\">\n<img width=\"710\" alt=\"Complex\" src=\"https://user-images.githubusercontent.com/1636709/210474078-d8c3c528-9bc6-4934-a970-4d372e3202a1.png\">\n\n</p>\n\n<!-- Getting Started -->\n## :toolbox: Getting Started\n\n<!-- Prerequisites -->\n### :bangbang: Prerequisites\n\nThis project uses poetry as the python package manager\n\n- `poetry` Follow the [poetry install](https://python-poetry.org/docs/) guide\n- `python3.8+` Download from [python](https://www.python.org/downloads/) (ideally `3.10`)\n\n```bash\n pip install wiseyoda\n```\n\n<!-- Usage -->\n## :eyes: Usage\n\nReminder: These commands must be run in the virtualenv where you installed the dependencies.\n\n```bash\n from wise_yoda import Quotes\n lesson = Quotes().random_quote()\n lesson = Quotes().select_quote(season=1, episode=1)\n```\n\n<!-- Run Locally -->\n### :running: Run Locally\n\nClone the project\n\n```bash\n git clone https://github.com/Mikaayenson/WiseYoda.git\n```\n\nGo to the project directory\n\n```bash\n cd wise_yoda\n```\n\nInstall system and Python dependencies\n\n```bash\n make deps\n```\n\nRun wiseyoda\n\n```bash\n wiseyoda --help\n```\n\n<!-- Development -->\n### :construction: Development\n\n\n<div align=\"center\">\n <img width=\"710\" alt=\"makefile\" src=\"https://user-images.githubusercontent.com/1636709/210474182-474a778f-9267-4e7c-84d3-3edb48cc9f8a.png\">\n</div>\n\nInstall pre-commit\n\n```bash\n pre-commit install\n```\n\nUpdate Python dependencies\n\n```bash\n make deps-py-update\n```\n\n<!-- Running Tests -->\n### :test_tube: Running Tests\n\nRun tests\n\n```bash\n make test\n```\n\nRun linter\n\n```bash\n make check\n```\n\n<!-- Build: Poetry -->\n### :triangular_flag_on_post: Build: Python Package\n\nBuild this project as a `sdist` and `wheel`\n\n```bash\n make build\n```\n\n\n<!-- License -->\n## :warning: License\n\nDistributed under the Apache2.0 License. See LICENSE.txt for more information.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Quote the wise and powerful master Yoda.",
"version": "1.0.1",
"split_keywords": [
"star wars",
"yoda",
"quotes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72e58d02926ccbff1a2618fd5f63ddbda5078c56d6f280543b68fd40b85587b4",
"md5": "b5fa69b9948ea5d07b4286ca2997a5bc",
"sha256": "75add90be6abcabe9af363122263c676ab0ff99aa9e554a298122b5cfe3a11c3"
},
"downloads": -1,
"filename": "wiseyoda-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5fa69b9948ea5d07b4286ca2997a5bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 13885,
"upload_time": "2023-01-04T03:09:29",
"upload_time_iso_8601": "2023-01-04T03:09:29.694569Z",
"url": "https://files.pythonhosted.org/packages/72/e5/8d02926ccbff1a2618fd5f63ddbda5078c56d6f280543b68fd40b85587b4/wiseyoda-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d491f6a9f20a90399bfaa2bd726204d6b3dcf12ae8a4319d12a9bd450bd1066",
"md5": "ff5b78427111775c3035f8cc05c2a28f",
"sha256": "7ce21e463e7823dd32b7742e849e3485ab3d0caa00041b2bd27ddb576709a47f"
},
"downloads": -1,
"filename": "wiseyoda-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ff5b78427111775c3035f8cc05c2a28f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 15028,
"upload_time": "2023-01-04T03:09:31",
"upload_time_iso_8601": "2023-01-04T03:09:31.023091Z",
"url": "https://files.pythonhosted.org/packages/9d/49/1f6a9f20a90399bfaa2bd726204d6b3dcf12ae8a4319d12a9bd450bd1066/wiseyoda-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-04 03:09:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Mikaayenson",
"github_project": "WiseYoda",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wiseyoda"
}
JSON
