Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

mysocks package for easy file transfer and chat

Project description

mysocks

This repository contains my work on socket programming. The goal of this project is to provide a python package based on socket programming that can enable developers to create server-client backend for seamless and secure multiple file transfers, group chats, etc.

Prerequisites

Windows (Python3.x)

Installing dependencies

Note: You can skip this step, if you are installing the packages. Dependencies are listed below and in the requirements.txt file.

  • tqdm

Install one of python package managers in your distro. If you install pip, then you can install the dependencies by running pip3 install -r requirements.txt

Directory Structure

  • mysocks/ - Package folder which contains all the code files corresponding to package

TODO: Write example files for easy understanding

  • examples/ - Contains examples on how to use the package

Details of the package

  • utilities.py - Contains helper functions for the package
  • file_transfer - Code to transfer files. Contains two classes for sending/receiving files.
    • 1 - send_files
    • 2 - receive_files

TODO: Examples

Have a look at examples/ directory.

Documentation

Code documentation can be found here

Installation

A setup.py file is provided in the repository. You can run python3 setup.py install to install it at system level. If you don't have privileges to do so, you can install it at user level by running python3 setup.py install --user.

Contributing to the repository.

  • If you find any problem with the code, please feel free to open an issue.
  • Found something you can improve, please send me a pull request with your changes. I will be more than happy to review and approve them.

Contacting me

You can send an email to thecodeboxed@gmail.com

Note: If you find this code useful, please leave a star :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mysocks, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size mysocks-1.1.0.tar.gz (12.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page