Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
temichelle13 authored Jun 15, 2024
1 parent 909974d commit 6fd4d54
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Text Sorting Project

## Overview
The Text Sorting Project is designed to organize files and folders based on their content. It leverages various scripts to analyze, classify, rename, and structure files into a coherent hierarchical format.

## Features
- **Content Analysis**: Analyzes file content to determine its category.
- **Enhanced Classification**: Uses advanced algorithms for accurate content classification.
- **File Renaming**: Renames files based on their content to maintain a consistent naming convention.
- **Hierarchy Creation**: Creates a folder hierarchy based on file categories.
- **Integrated Organization**: Combines multiple functionalities to comprehensively organize files and folders.
- **Progress Tracking**: Demonstrates progress tracking during file processing.

## Requirements
Ensure you have the following Python libraries installed:
- Refer to `requirements.txt` for a complete list.

Install the required libraries using:
```bash
pip install -r requirements.txt
```

## Usage

1. **Content Analysis**
Run `content_analyzer.py` to analyze and categorize file content.
```bash
python content_analyzer.py
```

2. **Enhanced Classification**
Run `enhanced_classifier.py` for advanced classification.
```bash
python enhanced_classifier.py
```

3. **File Renaming**
Run `file_renamer.py` to rename files based on content.
```bash
python file_renamer.py
```

4. **Hierarchy Creation**
Run `hierarchy_creator.py` to create a folder structure.
```bash
python hierarchy_creator.py
```

5. **Integrated Organization**
Run `integrated_file_organizer.py` for full-scale organization.
```bash
python integrated_file_organizer.py
```

## Testing
Use `test_utils.py` to run tests and validate the functionalities.
```bash
python test_utils.py
```

## Contributing
Feel free to fork the repository and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
```
### Additional Notes
- Ensure all dependencies listed in `requirements.txt` are installed.
- Customize the scripts as needed for specific use cases.
- Contributions are welcome; please adhere to the contribution guidelines.
This README provides a comprehensive guide to understanding and using the "Text_Sorting_Project" repository. If you have any questions or need further assistance, feel free to ask!

0 comments on commit 6fd4d54

Please sign in to comment.