Skip to main content

osd-slides is a tool to download Prof. Paine's slides through terminal with one command.

Project description

osd-slides

osd-slides is a tool to download and search Prof. Paine's slides through terminal or with one command or as library.

License: MIT GitHub issues codecov build PyPI Docs

Overview

  • Open Software Development classes slides are hard to turn it to a pdf and download and search for keywords. This tool will help students to download slides and search for keywords in slides easily.
  • This tool can be used as a library or run from command line.

Features

  • Read what slides are available
  • Download osd slides.
  • Search for keywords in the slides.

Install

pip install osd-slides

Dependencies

To install decktape, run in osd-slides.

$ npm install decktape

You will need node.js on your computer for above to run. Check if node.js in your computer by running this. And then check the version of npm. You might want to restart your terminal/powershell after installing node.js.

$ Node --version
$ npm --version

How to use

Users can download files by calling searchAndDownloadPdf().

from osd-slides.osd_slides.main import Downloader
downloader = Downloader()
downloader.searchAndDownloadPdf()

Users can view what files can be downloaded by calling showDownloadablePdf()

from osd-slides.osd_slides.main import Downloader
downloader = Downloader()
downloader.showDownloadablePdf()

Users can search for keywords in slides and open the exact slide the keyword exists.

from osd-slides.osd_slides.search import Search
url = "https://www.cs.columbia.edu/~paine/4995/lectures/"
search = Search(url, ["22-legal.html","21-econ.html"])
search.lookup("Legal")
search.open(1)

Example

As said above users can search for keywords in slides and open the exact slide the keyword exists.

from osd-slides.osd_slides.search import Search
url = "https://www.cs.columbia.edu/~paine/4995/lectures/"
search = Search(url, ["22-legal.html","21-econ.html"])
search.lookup("Legal")
search.open(1)

or running the project from command line like this

$ python osd-slides/osd_slides/__main__.py search
Which slides would you like to search in? Please provide slides with spaces between them: 
>> 22-legal.html 21-econ.html
Slides reading completed
What keyword would you like to look up: 
>> Legal
Slides that can be found are
[(1, 0, '22-legal.html'), (1, 1, '22-legal.html'), (2, 0, '22-legal.html')]
Which one would you like to open? please provide the number.
>> 2

will result in the following:

A gif image on searching

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osd_slides-0.2.1.tar.gz (327.3 kB view details)

Uploaded Source

File details

Details for the file osd_slides-0.2.1.tar.gz.

File metadata

  • Download URL: osd_slides-0.2.1.tar.gz
  • Upload date:
  • Size: 327.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.4

File hashes

Hashes for osd_slides-0.2.1.tar.gz
Algorithm Hash digest
SHA256 efca0e1e4cd50df1ce608a4998fa1af746ead76c171e8bca467dca17f5a8f4b5
MD5 77e3b9c71d3f50744b70077b447dfad6
BLAKE2b-256 ffc2adbc3d1c9442b299e5b85455304a9d32c3f0aa0d056689cce087fc61e17b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page