WiseYoda

Quotes from the Wise Yoda

Report Bug · Request Feature

:star2: 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!

:camera: Screenshots

:toolbox: Getting Started

:bangbang: Prerequisites

This project uses poetry as the python package manager

• poetry Follow the poetry install guide
• python3.8+ Download from python (ideally 3.10)

   pip install wiseyoda

:eyes: 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)

:running: 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

:construction: Development

Install pre-commit

  pre-commit install

Update Python dependencies

  make deps-py-update

:test_tube: Running Tests

Run tests

  make test

Run linter

  make check

:triangular_flag_on_post: Build: Python Package

Build this project as a sdist and wheel

  make build

:warning: License

Distributed under the Apache2.0 License. See LICENSE.txt for more information.