Git Product home page Git Product logo

resume-manager-cli's Introduction

resume-manager-cli

resume-manager-cli's People

Contributors

farzaanshaikh avatar

Watchers

 avatar

resume-manager-cli's Issues

Create the preview command

The Preview Command

The preview command will be used to build a new pdf preview or overwrite if one exists. It will include the option to create additional previews.

Context

The preview feature is one of the strong functionalities provided by this CLI. It has two use cases:

  1. Used as a save state. A new preview can be added to the resume preserving the original state if things go sideways.
  2. Used to compare multiple variations. This could be things like fonts, themes or anything that requires side-by-side visuals.

Features

  1. If no previews exist, the command will create a new preview. This will be a new tex file with the suffix '_p1' indicating the preview number. Additionally the the tex file will be built using lualatex and will appear as pdf in the 'preview' directory.
  2. If a preview exists, it will be used as an update. It will build & overwrite both the existing tex and pdf files.
  3. A '--new' flag will be used to create a new preview (tex and pdf file). These will be treated as current and subsequent preview commands will update these.
  4. A 'delete' subcommand will be used to delete a preview. It will accept the resume name (the name specified while creating a new resume) as an argument and will prompt the user to select the preview to be deleted. This action is irreversible.
  5. A 'restore' subcommand will be used to restore a specified preview to the original file. The original tex file of the resume will be overwritten by the contents of the preview's tex file. This subcommand is provided for very niche cases that I can think of.

File name convention

All preview files (tex and pdf) will follow the following naming convention
(Author name)_(Resume name)_p(preview number).(tex/pdf)
ex: Farzaan_Main_p2.tex

Create the 'new' command

The 'new' command will be used to create a new WIP resume.
It must do the following:

  1. Ask the name of the resume. Generic or industry/company specific resume can be defined by name here.
  2. Ask if the author would like to use a template. If yes then search & return a list of templates to choose from.
  3. Create the latex file to be used with the above settings.

Create better filenames using 'new' command

The names of the file created by the new command should be as follows:
(Author name)_(Resume name).(tex/pdf)

Names do not have spaces between them. Makes parsing easier.

Create the Cli and add the init command

Objective

Create the reman cli and add the init command to initialize a new résumé directory structure. This will serve as a base to manage all your résumés.

Task Definition

The cli

Create the base cli with the command name reman, abbreviation for 'résumé manager'.

The init Command

This command intializes a working directory for all résumés. The folders created as follows:

  • src : The source directory for all latex and related files.
    • custom : Contains all class/package files used by the latex files in src directory.
    • templates : Templates are latex files to be used for creating new résumés.
    • output : Any post-rendering files such as logs or auxiliaries go here.
  • preview : Renders of in-progress résumé will be stored here.
  • resume : Finalized résumé pdfs go here.

Create the 'config' command

The config command must take in author name. Any additional work on this command will progress passively as and when required.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.