gitfs is a FUSE file system that fully integrates with git - Version controlled file system

Last update: Jan 08, 2023

Overview

gitfs

Welcome to GitFS

gitfs is a FUSE file system that fully integrates with git. You can mount a remote repository's branch locally, and any subsequent changes made to the files will be automatically committed to the remote.

gitfs was developed by the awesome engineering team at Presslabs, a Managed WordPress Hosting provider.

What's its purpose?

gitfs was designed to bring the full powers of git to everyone, no matter how little they know about versioning. A user can mount any repository and all their changes will be automatically converted into commits. gitfs will also expose the history of the branch you're currently working on by simulating snapshots of every commit.

gitfs is useful in places where you want to keep track of all your files, but at the same time you don't have the possibility of organizing everything into commits yourself. A FUSE filesystem for git repositories, with local cache.

Installing

We provide packages for the major Ubuntu releases and MacOS, but you can find community packages for most of popular Linux distributions. If you want to build packages for a distribution, or you already did, please contact us and we'll list it here.

Ubuntu 18.04+

sudo add-apt-repository ppa:presslabs/gitfs
sudo apt-get update
sudo apt-get install gitfs

MacOS

brew install gitfs

Pip

We also publish a package to PyPI, which can be installed via pip using the following commmand:

pip install gitfs

Usage

You can mount a remote or local repository easly, just by providing the repository to clone and a directory used to mount.

gitfs http://your.com/repository.git /mount/directory

The entire filesystem can be tweaked when mounting it, using a set of options.

gitfs [email protected]:user/repo.git /mypath -o
repo_path=/tmp/path,branch=dev,log=-,debug=true,foreground=true,fetch_timeout=0.1,merge_timeout=0.1...

For an entire list of options, you can check the arguments page.

Features

Automatically commits changes: create, delete, update files and their metadata
Browse through working index and commit history
Merges with upstream by automatically accepting local changes
Caching commits reduces the memory footprint and speeds up navigation
Reduces the number of pushes by batching commits

Development

You can find more documentation on gitfs homepage.

Contributing

Development of gitfs happens at http://github.com/presslabs/gitfs.

Issues are tracked at http://github.com/presslabs/gitfs/issues.

The Python package can be found at https://pypi.python.org/pypi/gitfs/.

You are highly encouraged to contribute with code, tests, documentation or just sharing experience.

Please see CONTRIBUTING.md.

License

This project is licensed under Apache 2.0 license. Read the LICENSE file in the top distribution directory for the full license text.

Comments

Can't install on OS X 10.11

I'm having issues installing gitfs on OS X 10.11

Logs: https://gist.github.com/kaendfinger/4275d68ac2bf1817492b

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

opened by azenla 16
Port to python3 [$20]

Gitfs was written using only Python 2 code, but now, as the things in Python 3 evolves and are very stable, we need to port our Python 2 code to Python 3 compatible code.

Did you help close this issue? Go claim the $20 bounty on Bountysource.
bounty

opened by vtemian 7
Fix installation issues due to outdated deps
This fixes pip installation and the associated installation issues:

https://github.com/PressLabs/gitfs/issues/273

https://github.com/PressLabs/gitfs/issues/271

https://github.com/PressLabs/gitfs/issues/268

https://github.com/PressLabs/gitfs/issues/267
opened by nikvdp 5

[mac os x sierra] raven==5.27.0 distribution was not found and is required by gitfs

$ brew --version
Homebrew 1.2.4
Homebrew/homebrew-core (git revision ff3c; last commit 2017-07-06)
$ uname -mrs
Darwin 16.6.0 x86_64
$ brew cask install osxfuse
# success
$ brew install gitfs
# success
$ gitfs http://52.64.121.123/issues.git issues
Traceback (most recent call last):
  File "/usr/local/bin/gitfs", line 6, in <module>
    from pkg_resources import load_entry_point
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 3036, in <module>
    @_call_aside
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 3020, in _call_aside
    f(*args, **kwargs)
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 3049, in _initialize_master_working_set
    working_set = WorkingSet._build_master()
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 654, in _build_master
    ws.require(__requires__)
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 968, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pkg_resources/__init__.py", line 854, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'raven==5.27.0' distribution was not found and is required by gitfs

opened by khoan 5

pygit2 version needs to be bumped

pygit2 0.26.0 adds support for libgit2 0.26.0, so the version in requirements.txt should be bumped so that gitfs doesn't conflict with the latest libgit2.

Cf. https://github.com/Homebrew/homebrew-core/pull/14731

As a side note, fusepy 2.0.4 is also available now.

opened by ilovezfs 4
Port to python3

OK, Python 3.4 support works fine. It would be cool to have it test for Python 2.7 as well at some point. Are you planning to support Python 2 long term?

opened by justuswilhelm 4

Installation error: Command "python setup.py egg_info" failed with error code 1

Encountering this installation error on macOS Sierra:

Stians-Mac-mini:~ stian$ brew install homebrew/fuse/gitfs
==> Installing gitfs from homebrew/fuse
==> Using the sandbox
==> Downloading https://github.com/PressLabs/gitfs/archive/0.4.5.1.tar.gz
Already downloaded: /Users/stian/Library/Caches/Homebrew/gitfs-0.4.5.1.tar.gz
==> Downloading https://files.pythonhosted.org/packages/5c/79/5dae7494b9f5ed061cff9a8ab8d6e1f02db352f3facf907d9eb614fb80e9/virtualenv-15.0.2.tar.gz
Already downloaded: /Users/stian/Library/Caches/Homebrew/gitfs--homebrew-virtualenv-15.0.2.tar.gz
==> python -c import setuptools... --no-user-cfg install --prefix=/tmp/gitfs--homebrew-virtualenv-20170105-62989-mbq7ql/target --single-version-externally-managed --record=installed.txt
==> python -s /tmp/gitfs--homebrew-virtualenv-20170105-62989-mbq7ql/target/bin/virtualenv -p python /usr/local/Cellar/gitfs/0.4.5.1/libexec
==> Downloading https://files.pythonhosted.org/packages/86/8c/70aea8215c6ab990f2d91e7ec171787a41b7fbc83df32a067ba5d7f3324f/atomiclong-0.1.1.tar.gz
Already downloaded: /Users/stian/Library/Caches/Homebrew/gitfs--atomiclong-0.1.1.tar.gz
==> /usr/local/Cellar/gitfs/0.4.5.1/libexec/bin/pip install -v --no-deps --no-binary :all: --ignore-installed /private/tmp/gitfs--atomiclong-20170105-62989-1ngho46/atomiclong-0.1.1
Last 15 lines from /Users/stian/Library/Logs/Homebrew/gitfs/03.pip:
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/commands/install.py", line 335, in run
    wb.build(autobuilding=True)
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/wheel.py", line 749, in build
    self.requirement_set.prepare_files(self.finder)
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/req/req_set.py", line 380, in prepare_files
    ignore_dependencies=self.ignore_dependencies))
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/req/req_set.py", line 634, in _prepare_file
    abstract_dist.prep_for_dist()
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/req/req_set.py", line 129, in prep_for_dist
    self.req_to_install.run_egg_info()
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/req/req_install.py", line 439, in run_egg_info
    command_desc='python setup.py egg_info')
  File "/usr/local/Cellar/gitfs/0.4.5.1/libexec/lib/python2.7/site-packages/pip/utils/__init__.py", line 707, in call_subprocess
    % (command_desc, proc.returncode, cwd))
InstallationError: Command "python setup.py egg_info" failed with error code 1 in /private/tmp/pip-zmQCsP-build/

READ THIS: https://git.io/brew-troubleshooting

Stians-Mac-mini:~ stian$

opened by stianhoiland 3

SyncWorker fails silently

Sometimes, under suspect circumstances, SyncWorker will fail and no synchronization will be done.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

opened by vtemian 3
Misaligned code bug

Hi guys,

I was just checking out the source code, coming from BountySource. I noticed on lines 446 - 462, the code is not indented. They are referencing first_commit and second_commit which are only defined within the loop.

Let me know if this is correct and I'll fire away a PR.

~ Daniel

opened by daniellockyer 3
Bugs bounty [$10]

We want to make gitfs as stable as possible, so we are in search for bugs. We'll add a bounty on bountysource.com for each discovered bug.

There is a $10 open bounty on this issue. Add to the bounty at Bountysource.
bounty easy

opened by vtemian 3
Log exception messages on failures

For example when a fetch fails, it only logs Fetch failed without a reason. We should log exceptions with log.exception(message). This would make debugging errors much more easy.

This I found to be the case only on FetchWorker.
bug

opened by calind 3
Can't install

Hi, doesn't install in newer ubuntu with the commands you give.

installing with brew, running gives this error.

Traceback (most recent call last): File "/home/linuxbrew/.linuxbrew/bin/gitfs", line 33, in sys.exit(load_entry_point('gitfs==0.5.1', 'console_scripts', 'gitfs')()) File "/home/linuxbrew/.linuxbrew/Cellar/gitfs/0.5.2_9/libexec/lib/python3.9/site-packages/gitfs/init.py", line 19, in mount from gitfs.mounter import start_fuse File "/home/linuxbrew/.linuxbrew/Cellar/gitfs/0.5.2_9/libexec/lib/python3.9/site-packages/gitfs/mounter.py", line 22, in from pygit2.remote import RemoteCallbacks ImportError: cannot import name 'RemoteCallbacks' from 'pygit2.remote' (/home/linuxbrew/.linuxbrew/Cellar/gitfs/0.5.2_9/libexec/lib/python3.9/site-packages/pygit2/remote.py)

opened by nkh 0
Python atomiclong seems to be discontinued

I was just looking through the dependencies and noticed that the atomiclong dependency (requirements.txt) seems to be discontinued with the developer saying not to use it. I'm not sure if this recommendation is because they wish to no longer maintain it or if there are underlying issues, does anyone have any input or awareness involving this?

opened by Doom4535 0
Python 3.10: MutableMapping has moved to collections.abc
https://docs.python.org/3/whatsnew/3.10.html#removed bullet eight...

Remove deprecated aliases to Collections Abstract Base Classes from the collections module. (Contributed by Victor Stinner in bpo-37324.)

Related to Homebrew/homebrew-core#90923
opened by cclauss 1

Releases(0.5.2)

0.5.2(Oct 20, 2019)

Cleanup and update documentation.
Source code(tar.gz)
Source code(zip)
gitfs-0.5.2-1.14.src.rpm(70.89 KB)
gitfs-0.5.2-1.14.x86_64.rpm(82.41 KB)
gitfs.spec(1.12 KB)
0.5.1(Oct 19, 2019)

Source code(tar.gz)
Source code(zip)
0.5.0(Oct 18, 2019)
update requirements, including the ones used for testing

support python 2.7, 3.4, 3.5, 3.6, 3.7 and 3.8

test and add support for ubuntu 18.04

format everything with black

Source code(tar.gz)
Source code(zip)
0.4.5.1(Dec 8, 2016)
fix typo for max_open_files argument on mount

Source code(tar.gz)
Source code(zip)
0.4.5(Dec 7, 2016)
add max_open_files mount option which allow to specify a files open hard and soft limit #259

Source code(tar.gz)
Source code(zip)
0.4.4(Sep 30, 2016)
show a helpful message when trying to clone an empty repository #239

log exception only on failed push #240

add sentry tags #244

upgrade pygit2 to 0.24.1

Source code(tar.gz)
Source code(zip)
0.4.3(Aug 17, 2016)
improve commit message thanks to @tusharmakkar08

Source code(tar.gz)
Source code(zip)
0.4.2(Jul 1, 2016)
fix pending writers bug #223

cleanup code and error messages (thanks to @promulo and @ChristianAlexander)

Source code(tar.gz)
Source code(zip)
0.4.1(Mar 30, 2016)
add credentials to push and fetch operations #226 (hotfix)

Source code(tar.gz)
Source code(zip)
0.4.0(Mar 29, 2016)
delete directories on force checkout #221

improve logging #222

retry mechanism for push #201

port to python3 thanks to @justuswilhelm #199

improve test running speed thanks to @rciorba

improve development using vagrant

Source code(tar.gz)
Source code(zip)
0.3.3(Jun 18, 2015)
fetch before you merge #194

Source code(tar.gz)
Source code(zip)
0.3.2(Jun 5, 2015)
solve logging bug #190

fix merging conflict bugs #176

add more tests for directoy deletion #184

Source code(tar.gz)
Source code(zip)
0.3.1(Feb 19, 2015)
fix Makefile

[NOTICE] Don't use 0.3 version, use this instead.
Source code(tar.gz)
Source code(zip)
0.3(Feb 13, 2015)
=== 0.3 ==

upgrade pygit to 0.22.0

fix deleting a directory bug #180

introduce idle mode #156

close minor issues: #97, #177

Source code(tar.gz)
Source code(zip)
0.2.5(Dec 12, 2014)

Added MANIFEST.in
Source code(tar.gz)
Source code(zip)
0.2.4(Dec 10, 2014)
feature: added hard_ignore and ignore_file mount options

fixed: link syscall

change: .gitmodules file is read-only

Source code(tar.gz)
Source code(zip)
0.2.3(Nov 13, 2014)
feature: send erros to sentry. Can be configured by environment variable SENTRY_DSN or sentry_dsn mount option

fixed the way .gitignore entries are checked

improved logging

Source code(tar.gz)
Source code(zip)
0.2.2(Nov 10, 2014)
upgrade to pygit2 0.21.4

fix #157: use log.exception to log exception when push/fetch fails

Source code(tar.gz)
Source code(zip)
0.2.1(Oct 29, 2014)
fix __version__ import error

added support for publishing on pypi from drone

Source code(tar.gz)
Source code(zip)
0.2(Oct 27, 2014)
fix #152: logger should include remote_url

fix #153: make sure that no empty commits are ever created

fix #154: add version

fix #123: remove duplicate code

fix #79: duplicate code in Repository._get_git_object and Repository._get_git_object_type

Source code(tar.gz)
Source code(zip)
0.1.2(Oct 23, 2014)
fix #136, #137, #140: various bugs related to directory creation/removal

fix #144, #145, #146: various bugs related to cache system

fix #142: /current is unavailable when repo_path is relative

fix #148: don't push empty commits

fix #149: commiter_name should be args.user

fix #150: submodules are not ignored

Source code(tar.gz)
Source code(zip)
v0.1.1(Oct 15, 2014)
fix #129: use ssh user from clone url

fix #134: pushing on repos requiring authentication was not working

Source code(tar.gz)
Source code(zip)
v0.1.0(Oct 13, 2014)

Hello and welcome to gitfs! 600+ commits and this is the first release.
Source code(tar.gz)
Source code(zip)