Git Product home page Git Product logo

track-job-applications's Introduction

Track Job Applications

A CLI application to help you track job applications and provide metrics on them.

MIT License Open Issues Good First Issues

This can help you answer questions like:

  • In how many companies have I been shortlisted yet?
  • What companies rejected my profile?
  • In how many companies I've given tech interviews?
  • In how many HR rounds I got rejected?
  • How many offers do I have? Though you won't forget this one!

And the list goes on.

Python SQLite SQLAlchemy

Table of Contents

Documentation

The documentation for this project is created using Mkdocs and deployed on GitHub Pages.

You can find the documentation here: https://aditya-gupta1.github.io/track-job-applications/

Installation

Prerequisites: Python

Run the following command to install the application:

pip install track-job-applications

Getting Started

// add a job application
> track-job add CompanyX SDE-1

// display all the applications
> track-job ls

// update the application details
> track-job update company <application-id> <new company name>

// know more about any command
> track-job <command> --help

// know about all the commands available
> track-job --help

// get a report on all the applications
> track-job report

// get report on all the applications made within a date range
> track-job report -s <start date in YYYY-MM-DD> -e <end date in YYYY-MM-DD>

// total applications rejected
> track-job report status rejected

Refer to the commands section in the documentation for the list of commands available.

Note: All the commands have a --start-date or -s argument to mention the start date and --end-date or -e argument to specify the end date, in case the command is to run for applications made within a date range. Also, the data model in which applications are stored can be found in references section in the docs.

Contributing

Contributions for docs as well as code are welcomed. Head over to the Contributing guidelines for steps to set up a development environment, contributing to code and contributing to docs.

Reach out

Feel free to start a discussion on anything you want to suggest or have more clarity on.

License

MIT License

track-job-applications's People

Contributors

issac5693 avatar itsadityagupta avatar itsadityaguptaa avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

track-job-applications's Issues

[FEATURE] Format printing basis on the status

When listing the applications using the ls command, colour each job application printed on the basis of its status.

For rejected, print it in red.
For applied, print it in orange.
For Offer, print it in green.
For any other status, print it in yellow.

[FEATURE] Metrics to be reported from Job Applications

This is an umbrella issue to discuss and gather the relevant metrics to be reported on the job applications.

  • Total no of applications
  • Total no of applications in a given date range
  • Total applications rejected
  • Total applications rejected in a given date range
  • Ratio of (jobs applied/jobs rejected) [Note: Rejection can happen after shortlisting as well]
  • Ratio of (jobs applied/job shortlisted)

[BUG] updated_at field not updating after successful updates

Describe the bug
The updated_at field is supposedly not updated in all the update commands

To Reproduce
Steps to reproduce the behaviour:

  1. run track-job update company <application-id> <new-company name>

Expected behaviour
updated_at field should be updated with the current date

Screenshots
NA

Add a custom badge for SQLAlchemy in README's tech stack section

Create a badge for SQLAlchemy using its logo and put it under the Tech Stack section.

Image: https://www.sqlalchemy.org/img/sqla_logo.png

Tools like shields.io or any other relevant tools can be used to create a custom badge (Just like already mentioned in the README)

Steps:

  1. Go to https://shields.io/
  2. Scroll below to the Your Badge Section.
    image
  3. Leave the label field empty.
  4. Populate the message as SQLAlchemy
  5. Use the colour blue.
  6. Click on the make badge button.
  7. You'll get a URL for the badge.
  8. Add it to the README's tech stack section below the already existing Badges there.

[FEATURE] Add a flag to view all shortlisted applications

Please describe your feature request in as detail as possible.
Add a flag in the ls command to view all the shortlisted applications.

Is your feature request related to a problem? Please describe.
No.

If it's related to a problem, what should happen after solving this problem
users can view all the shortlisted applications using the command track-job ls --shortlisted along with other command options.

Suggest the implementation plan for the feature. If any.
Add a typer option and use the get_shortlisted_applications function from db_handler to get the application details. Call this function from the list function in the job_tracker.py file.

Additional context
NA

[BUG] Docstrings are not formatted correctly in --help flag

Describe the bug
The docstrings are not formatted properly when calling --help in the command.

To Reproduce
Run any command with the --help flag.

Expected behaviour
The docstrings should be formatted correctly along with all the whitespaces and newlines.

Screenshots
image

Additional context
NA

[FEATURE] Add a PR Template

Is your feature request related to a problem? Please describe.
No PR template

Describe the solution you'd like
Add a PR template

Describe alternatives you've considered
NA

Additional context
NA

[FEATURE] Update README with the open source template from auth0

Please describe your feature request in as detail as possible.
Update the README along with all the other required files following the template from auth0: https://github.com/Aditya-Gupta1/open-source-template

Is your feature request related to a problem? Please describe.
It's not clear for new users to get started with the project.

If it's related to a problem, what should happen after solving this problem
The users should have a clear idea about the project. They should be able to get started quickly and have a good enough starting point to start contributing to the project.

Suggest the implementation plan for the feature. If any.
Take reference from the auth0 template as mentioned above.

Additional context
NA

[FEATURE] Add test cases

Please describe your feature request in as detail as possible.
Add test cases in the tests folder preferably using typer's testing functionality.

Is your feature request related to a problem? Please describe.
No

If it's related to a problem, what should happen after solving this problem
No

Suggest the implementation plan for the feature. If any.
I need to gather the required understanding of writing tests using typer and then implementing them.

Additional context
NA

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.