PyFileMaster

A Comprehensive File Handling Utility for Python

About PyFileMaster

PyFileMaster is an open-source Python package designed to simplify file handling tasks. Created by Shubhashish Chakraborty, this package provides a set of powerful and easy-to-use methods for handling files, including reading, writing, and converting between formats such as binary (.dat), CSV (Excel), and text files.

With PyFileMaster, file operations become seamless. Simply provide the file path, and let the library handle the heavy lifting for you — no need for extra code or complex logic!

Features and Functionalities (As of )

• Write Binary Files (writeBinFile)
  It creates a Binary file containing Data which is being passed, List of dictionaries to be stored in the file:

  import pyfilemaster as pfm
  
  pfm.writeBinFile("<path_name_of_your_binary_file>" , [
      {
          'name': 'Andrew',
          'language': 'python'
      },
      {
          'name': 'Tristan',
          'language': 'JavaScript'
      }
  ])

• Read Binary Files (readBinFile)
  Effortlessly reads and prints the contents of a binary (.dat) file.

  import pyfilemaster as pfm
  
  fileData = pfm.readBinFile("<path_to_your_binary_file>")
  
  print(fileData)

• Convert Binary to CSV (convertBinToCSV)
  Converts data from a binary (.dat) file to a CSV (Excel) file in just one step.

  import pyfilemaster as pfm
  
  pfm.convertBinToCSV("<path_to_your_binary_file>", "<name_of_the_generated_csv_file>")

Installation

Install the Latest Version

To get started with PyFileMaster, install it via pip:

pip install pyfilemaster

Alternative commands (if pip requires specific environment handling):

pip3 install pyfilemaster
sudo pip install pyfilemaster

Getting Started

1. Install the package using the installation instructions provided above.
2. Import the package into your Python script to start using its functionalities:

   import pyfilemaster as pfm

3. Start using the available methods like readBinFile or convertBinToCSV to handle your file operations!

Contributing

We welcome contributions from the community! Here's how you can contribute:

1. Fork the repository on GitHub.
2. Make your changes in a separate branch.
3. Submit a pull request explaining your changes.

Reporting Issues

If you encounter bugs or have feature requests, please open an issue on our GitHub Issues Page.

Future Updates

We are committed to making PyFileMaster a comprehensive file-handling utility. More features and functionalities will be continuously added in future updates to enhance its versatility and meet evolving user needs.
Stay tuned for exciting new capabilities, and feel free to suggest ideas or improvements by opening an issue on our GitHub repository!

License

This project is Licensed under the MIT License
Feel free to use, modify, and distribute this project in your own applications while respecting the terms of the license.

Connect with the Author

Created and maintained by Shubhashish Chakraborty
For any queries, reach out via email at [email protected].
PyPi Profile: beingshubh || Shubhashish Chakraborty