search

miketeo / pysmb

pysmb is an experimental SMB/CIFS library written in Python. It implements the client-side SMB/CIFS protocol (SMB1 and SMB2) which allows your Python application to access and transfer files to/from SMB/CIFS shared folders like your Windows file sharing and Samba folders.
Other
340 stars 94 forks source link

Request to Update Documentation for SMBConnection Class #217

Closed Niskeletor closed 9 months ago

Niskeletor commented 9 months ago

Dear miketeo,

I hope this message finds you well. I am writing to suggest an update to the pysmb documentation, specifically the page on the SMBConnection class (https://pysmb.readthedocs.io/en/latest/api/smb_SMBConnection.html).

I have noticed that the is_direct_tcp argument in the SMBConnection class is not documented on this page. This parameter seems particularly important for modern SMB connections, especially considering the widespread move away from SMB1 protocol.

Including information about the is_direct_tcp parameter would greatly benefit users who are looking to implement SMB connections using pysmb, especially those needing more secure and up-to-date connection methods.

Thank you for your attention to this matter. I appreciate the effort you put into maintaining such a useful resource for the community.

Best regards, [Niscode]

miketeo commented 9 months ago

@Niskeletor Hi, thank you for raising this issue. I will try to address the missing parameter in the docs over this weekend.

Niskeletor commented 9 months ago

I wanted to extend my heartfelt thanks for your prompt response and commitment to updating the pysmb documentation. Your willingness to address the issue I raised is not only a testament to your dedication to this project but also a significant contribution to the Python development community.

As someone who is relatively new to the intricate world of programming, I understand that my query regarding the is_direct_tcp parameter might seem elementary to seasoned developers. Initially, I was perplexed by the idea that simply changing the port from 139 to 445 would suffice for modern SMB connections. It was only after delving into the source code of your repository and comparing it with other community examples that I realized the necessity of including the is_direct_tcp parameter.

Your work on pysmb has been a beacon of guidance for newcomers like myself, who are navigating the complex yet rewarding path of Python programming. By enhancing the documentation, you are not just improving a tool but are also lighting the way for many "noobs" who might feel lost in this journey.

It's contributions like yours that make the Python community so vibrant and welcoming. I am truly grateful for your support and for sharing your expertise with all of us.

Thank you once again for your invaluable contribution to our learning and development.

Warm regards,

miketeo commented 9 months ago

@Niskeletor I have fixed the issue in the documentation. The methods and parameters were omitted because of a misconfiguration in the readthedocs config. It has been fixed and all the methods and parameters for each pysmb class are now showing on the pysmb readthedocs web site now.

Niskeletor commented 9 months ago

@miketeo Thank you so much for the quick fix and for updating the pysmb documentation! It's greatly appreciated and incredibly helpful for developers like me.

Best regards,