search

interviewstreet / ghs

Cross-platform CLI tool to generate your Github profile's stats and summary.
137 stars 89 forks source link

CI/CD workflows + Docker setup + Code formatting #3

Closed HarshCasper closed 2 years ago

HarshCasper commented 2 years ago

Description

This PR:

makkoncept commented 2 years ago

Thank you @HarshCasper for the contribution!

  1. The project was already using autopep8 for formatting (it's also mentioned in CONTRIBUTING.md). But I guess we can adopt black because it's has sensible defaults which takes out the pain of constant configuration and also black is widely adopted by the python community.
  2. Cool. Can you update the CONTRIBUTING.md#coding-style to mention that we use black for code formatting and flake8 as the linter.
  3. Cool. Added a minor comment above.
  4. I don't think that dockerizing the package has any advantages. If the idea is to isolate the installation and don't affect the host machine, then pipx is more straightforward than this (also, the good old virtual environment can also be used). Though I don't have any strong opinions on this. Would love to hear your thoughts on this point.
Rohit484 commented 2 years ago

https://github.com/Rohit484

HarshCasper commented 2 years ago

Hi @makkoncept

I have made all the recommended changes. Coming to Dockerizing the package, I think it's a good addition to kick-start the CLI faster and reliably without having the user deal with virtual environments and making it ubiquitous to use. We can also offer an extended Docker image over GHCR/DockerHub which the users can pull and use without having to clone the repository or install the Python package.