README.md

PyChecksum

🛡️ Create and verify files hashes with one click
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. How to Build
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

🌠 About The Project

PyChecksum is used to automatically generate and verify multiple files hash with the most popular algorithms

🔰 How to Build

To get a local copy up and running, follow these simple steps.

1. Clone the repo

   git clone https://github.com/phamngocvinh/py-checksum.git

2. Install requirements

   pip install -r requirements.txt

3. Run build script
4. Executable file will be generated in dist folder

👨‍🏫 Usage

1. The first time you run, it will generate a hash for all file in the current folder (include sub-folder).
2. PyChecksum.hash containing all file's hashes will be generated.
3. Any time PyChecksum.hash exists, if you run again, it will check the current folder file's hash with hash in PyChecksum.hash
4. PyCheckResult.txt containing check result will be generated.

For more examples, please refer to the Documentation

🗺️ Roadmap

See the open issues for a list of proposed features (and known issues).

🚀 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📕 License

Distributed under the GPL-3.0 License. See LICENSE for more information.

📫 Contact

📚 Acknowledgements

• Python Software Foundation
• PyInstaller
• Shields.io