fds icon indicating copy to clipboard operation
fds copied to clipboard

Documentation request: using fds with git repo already using dvc

Open drjasonharrison opened this issue 2 years ago • 4 comments

It's not clear from the readme, or the blog posting, how to start using fds with a git repo already using dvc.

  • https://github.com/DAGsHub/fds/blob/main/README.md
  • https://dagshub.com/blog/fds-fast-data-science-with-git-and-dvc/

I can guess that all I need to do is install the fds python package, and I use pipenv, so that might work, but it isn't clear. I know "make a copy of your repo and try it out!" but how many experiments until I recreate the documentation that is so badly needed?

drjasonharrison avatar Mar 03 '22 17:03 drjasonharrison

Hi @drjasonharrison , I'm not exactly sure what information is missing. You can just start using fds as a convenience wrapper around git and DVC - you just don't need to run the fds init command, but all the other commands will work normally.

So e.g. if right now you run a lot of dvc status followed by git status, that will now be replaced by a single fds status.

fds doesn't require any additional setup on top of what git and DVC already do. You can stop/start using fds whenever you want. You can start with fds and then drop it to use vanilla git and DVC, and vice versa.

guysmoilov avatar Mar 07 '22 12:03 guysmoilov

Great, so if I have a git repo, and want to add dvc, then do dvc init and switch then to fds.

Have you seen gitless? https://github.com/gitless-vcs/gitless

drjasonharrison avatar Mar 07 '22 16:03 drjasonharrison

Does fds require a specific range of Python versions, that's why I mentioned pipenv (or any virtual environment). I s Assume that you are thinking that fds should be installed in the global pip environment.

drjasonharrison avatar Mar 07 '22 16:03 drjasonharrison

Hey, yeah we took inspiration from gitless when we came up with the idea of FDS, and even said so in the launch blog! It's a great project.

FDS requires Python >= 3.6 , as described in setup.py and the PyPI page. It's designed to be as portable as possible, so whichever virtual (or global) environment setup you prefer should be fine. I think in principle it might be simpler to have a global version, like with Git and other command line tools.

guysmoilov avatar Mar 07 '22 17:03 guysmoilov