๐ About the Project
Simple library to obtain wisdom from the wise Master Yoda in the form of quotes. Create a feature request if there are some useful features/commands that you hate to remember!
๐ท Screenshots
๐งฐ Getting Started
โผ๏ธ Prerequisites
This project uses poetry as the python package manager
-
poetry
Follow the poetry install guide -
python3.8+
Download from python (ideally3.10
)
pip install wiseyoda
๐ Usage
Reminder: These commands must be run in the virtualenv where you installed the dependencies.
from wise_yoda import Quotes
lesson = Quotes().random_quote()
lesson = Quotes().select_quote(season=1, episode=1)
๐ Run Locally
Clone the project
git clone https://github.com/Mikaayenson/WiseYoda.git
Go to the project directory
cd wise_yoda
Install system and Python dependencies
make deps
Run wiseyoda
wiseyoda --help
๐ง Development
Install pre-commit
pre-commit install
Update Python dependencies
make deps-py-update
๐งช Running Tests
Run tests
make test
Run linter
make check
๐ฉ Build: Python Package
Build this project as a sdist
and wheel
make build
โ ๏ธ License
Distributed under the Apache2.0 License. See LICENSE.txt for more information.