Metadata-Version: 2.1
Name: fs-code
Version: 0.1
Summary: PyFilesystems for GitLab, GitHub, and Git
Home-page: https://danjou.gitlab.io/fs-code
License: MIT
Author: Max Ludwig
Author-email: mail@danjou.dev
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: all
Provides-Extra: gitfs
Provides-Extra: githubfs
Provides-Extra: gitlabfs
Requires-Dist: PyGithub (>=1.55,<2.0); extra == "githubfs" or extra == "all"
Requires-Dist: dulwich (>=0.20,<0.21); extra == "gitfs" or extra == "all"
Requires-Dist: fs (>=2.4,<3.0)
Requires-Dist: python-gitlab (>=3.0,<4.0); extra == "gitlabfs" or extra == "all"
Requires-Dist: requests (>=2.26,<3.0); extra == "githubfs" or extra == "all"
Requires-Dist: schema (>=0.7,<0.8)
Requires-Dist: werkzeug (>=2.0,<3.0); extra == "gitlabfs" or extra == "githubfs" or extra == "all"
Project-URL: Documentation, https://danjou.gitlab.io/fs-code
Project-URL: Repository, https://gitlab.com/dAnjou/fs-code
Description-Content-Type: text/markdown

# fs-code

![pipeline status][pipeline status] ![3.8 coverage][3.8 coverage] ![3.10 coverage][3.10 coverage]

[PyFilesystems](https://www.pyfilesystem.org/) for GitLab, GitHub, and Git.

---

## Installation

TODO

## Usage

### with <a target="_blank" href="https://docs.pyfilesystem.org/en/latest/openers.html">FS URL</a>

```python
import fs

user_fs = fs.open_fs("gitlab://?user=dAnjou")
readme = user_fs.open("fs-code/main/README.md")
print(readme.read())
```

### with class

```python
from gitlab import Gitlab
from codefs.gitlabfs import UserFS

user_fs = UserFS(Gitlab(), user="dAnjou")
readme = user_fs.open("fs-code/main/README.md")
print(readme.read())
```

[pipeline status]: https://gitlab.com/dAnjou/fs-code/badges/main/pipeline.svg
[3.8 coverage]: https://gitlab.com/dAnjou/fs-code/badges/main/coverage.svg?job=test%3A%20%5Bpython%3A3.8%5D&key_text=3.8+coverage&key_width=90
[3.10 coverage]: https://gitlab.com/dAnjou/fs-code/badges/main/coverage.svg?job=test%3A%20%5Bpython%3A3.10%5D&key_text=3.10+coverage&key_width=90

