Skip to content

scottdodson/myEducation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

My Education

Leverages Thor and Ruby
[gem]: https://rubygems.org/gems/thor
[homepage]: http://whatisthor.com/

Description

As a student, I want to have a consistently coherent folder structure for my course materials.

This command line utility creates a standard set of directories for each course under a common term, and provides archiving with tar.

Simple folder structures and tar archives don't become obsolete or require subscriptions. The goal is to capture course files and information such that it is easy to use with the wide variety of courseware used in instruction, and provide an easy mechanism for archiving.

Wish list:
S3 cli archive upload Encryption

Installation

gem install thor
clone repository

sThreeSync command functionality is commented out. To enable you need to have an AWS S3 target bucket, AWS CLI 2 installed, an environment variable set with your bucket id, and be authenticated. AWS documentation covers a variety of ways to perform the AWS configuration.

Usage and documentation

This script was developed and used on linux.

List the commands included

thor list

Create a root directory in the Documents folder.

thor my_education:add_class TERM_NAME CLASS_NAME 

Add a class TERM_NAME CLASS_NAME.

thor my_education:add_class uw2024winter drama120

Create an archive file in the archives subfolder

thor my_education:archive

Sync archive directory with an AWS S3 bucket

thor my_education:sThreeSync

License

Released under the MIT License.
See the license file for further details.

About

Ruby and Thor script for creating and archiving coursework directories.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages