https://github.com/althonos/fs.smbfs

Pyfilesystem2 over SMB using pysmb

https://github.com/althonos/fs.smbfs

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary

Keywords

cifs filesystem pyfilesystem2 pysmb smb

Keywords from Contributors

progress-bar archive biopython moclo modular-cloning plasmids open-science system-biology bioinformatics annotation
Last synced: 5 months ago · JSON representation

Repository

Pyfilesystem2 over SMB using pysmb

Basic Info
  • Host: GitHub
  • Owner: althonos
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 143 KB
Statistics
  • Stars: 30
  • Watchers: 3
  • Forks: 15
  • Open Issues: 9
  • Releases: 33
Topics
cifs filesystem pyfilesystem2 pysmb smb
Created over 8 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog License

README.md

fs.smbfs star me

Source PyPI Actions Codecov Codacy License Versions Format GitHub issues Downloads Changelog

Requirements

| PyFilesystem2 | PyPI fs | Source fs | License fs | |:-|:-|:-|:-| | six | PyPI six | Source six | License six | | PySMB | PyPI pysmb | Source pysmb | License pysmb |

Installation

Install directly from PyPI, using pip :

console $ pip install fs.smbfs

Usage

Opener

Use fs.open_fs to open a filesystem with an SMB FS URL:

python import fs smb_fs = fs.open_fs('smb://username:password@SAMBAHOSTNAME:port/share')

The opener can use either an IPv4 address or a NetBIOS hostname, using the NetBIOS name service to find the other token. Otherwise, if NetBIOS is not available, a new SMB connection can be established by using the IPv4 address and giving the hostname with the hostname URL parameter.

The following parameters can be passed as URL parameters: timeout, name-port, direct-tcp, hostname, and domain.

Constructor

python import fs.smbfs smb_fs = fs.smbfs.SMBFS( host, username="guest", passwd="", timeout=15, port=139, name_port=137, direct_tcp=False, domain="" )

with each argument explained below:

  • host: either the host name (not the FQDN) of the SMB server, its IP address, or both in a tuple. If either the IP address or the host name is not given, NETBIOS is queried to get the missing data.
  • user: the username to connect with, defaults to "guest" for anonymous connection.
  • passwd: an optional password to connect with, defaults to "" for anonymous connection.
  • timeout: the timeout, in seconds, for NetBIOS and TCP requests.
  • port: the port the SMB server is listening on.
  • name_port: the port the NetBIOS naming service is listening on.
  • direct_tcp: set to True if the server is accessible directly through TCP, leave as False for maximum compatibility.
  • domain: the network domain to connect with, i.e. the workgroup on Windows. Usually safe to leave as empty string, the default.

Once created, the SMBFS filesystem behaves like any other filesystem (see the Pyfilesystem2 documentation), except if it was open in the root directory of the server, in which case the root directory of the SMBFS instance will be read-only (since SMB clients cannot create new shares).

Feedback

Found a bug ? Have an enhancement request ? Head over to the GitHub issue tracker of the project if you need to report or ask something. If you are filling in on a bug, please include as much information as you can about the issue, and try to recreate the same bug in a simple, easily reproducible situation.

Credits

fs.smbfs is developed and maintained by: - Martin Larralde

The following people contributed to fs.sshfs: - Mike DePalatis - Isaac Jackson - Max Klein - Francesco Frassinelli - Josiah Witheford

This project obviously owes a lot to the PyFilesystem2 project and all its contributors.

See also

  • fs, the core Pyfilesystem2 library
  • fs.archive, enhanced archive filesystems for Pyfilesystem2
  • fs.sshfs, Pyfilesystem2 over SSH using paramiko

Owner

  • Name: Martin Larralde
  • Login: althonos
  • Kind: user
  • Location: Heidelberg, Germany
  • Company: EMBL / LUMC, @zellerlab

PhD candidate in Bioinformatics, passionate about programming, SIMD-enthusiast, Pythonista, Rustacean. I write poems, and sometimes they are executable.

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 172
  • Total Committers: 10
  • Avg Commits per committer: 17.2
  • Development Distribution Score (DDS): 0.471
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Martin Larralde m****e@e****r 91
Martin Larralde m****e@e****e 45
Martin Larralde m****e@e****r 26
Max Klein t****n 3
Joeey j****d@g****m 2
Francesco Frassinelli f****4@g****m 1
Isaac Jackson m****n@g****m 1
Mike DePalatis d****s@g****m 1
Francesco Frassinelli f****i@n****o 1
dependabot-preview[bot] 2****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 24
  • Total pull requests: 17
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 19
  • Total pull request authors: 8
  • Average comments per issue: 1.96
  • Average comments per pull request: 3.18
  • Merged pull requests: 10
  • Bot issues: 1
  • Bot pull requests: 5
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • frafra (4)
  • telamonian (3)
  • jonfen (1)
  • bjudkewitz (1)
  • dependabot-preview[bot] (1)
  • GamalielMasters (1)
  • genben (1)
  • adyanth (1)
  • datty258 (1)
  • schilli (1)
  • tkossak (1)
  • JesperKrogh (1)
  • themowski (1)
  • Vegemash (1)
  • HungryTenor (1)
Pull Request Authors
  • telamonian (4)
  • frafra (3)
  • dependabot[bot] (3)
  • josiahwitheford (2)
  • genben (2)
  • dependabot-preview[bot] (2)
  • Vegemash (1)
  • mivade (1)
Top Labels
Issue Labels
bug (12) fixed (10) enhancement (3) docs (3) question (2) invalid (2)
Pull Request Labels
enhancement (6) dependencies (5) docs (2) invalid (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 48,265 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 7
  • Total versions: 32
  • Total maintainers: 1
pypi.org: fs.smbfs

Pyfilesystem2 over SMB using pysmb

  • Versions: 32
  • Dependent Packages: 3
  • Dependent Repositories: 7
  • Downloads: 48,265 Last month
Rankings
Downloads: 2.4%
Dependent packages count: 2.4%
Dependent repos count: 5.5%
Average: 6.3%
Forks count: 9.3%
Stargazers count: 11.9%
Maintainers (1)
Last synced: 6 months ago

Dependencies

tests/requirements.txt pypi
  • codecov * test
  • docker * test
  • mock * test
  • semantic-version * test
.github/workflows/publish.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
  • rasmus-saks/release-a-changelog-action v1.0.1 composite
.github/workflows/test.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v2 composite
setup.py pypi