A Flask-based web application designed to automate the process of sending CVs (Curriculum Vitae) via email. This project simplifies the job application process by allowing users to send their CVs to multiple recipients effortlessly.
- Project Description
- Technologies Used
- Installation
- Running the Application Locally
- Configuration
- Project Structure
- Contributing
- License
The AutoCV tool is built using Flask and aims to streamline the job application process for users by enabling them to send their CVs directly from a web interface. It utilizes a Python email module to handle email sending functionalities, allowing for easy management of multiple recipients.
- Python: The programming language used to develop the application.
- Flask: A lightweight WSGI web application framework for Python.
- SMTPLib: A built-in Python module for sending emails.
To get started with this project, ensure that you have Python and pip installed on your machine. Follow these steps to set up the project:
-
Clone the repository:
git clone https://github.com/mubbashirulislam/AutoCV.git cd AutoCV -
Install Flask (if not already installed):
pip install Flask
-
(Optional) Create a
requirements.txtfile to manage dependencies:pip freeze > requirements.txt
To run the Flask application locally, follow these steps:
-
Create your application files if not already created:
cv-automationScript.py: The main Flask application file.your_email_module.py: The module responsible for handling email functionalities.config.ini: A configuration file for storing your email credentials.
-
Open your terminal and navigate to the directory where your files are located.
-
Run the Flask application:
python cv-automationScript.py
-
Access the application: Open your web browser and go to
http://127.0.0.1:5000/. You can now use the application to send your CVs via email.
Before running the application, you need to set up your email credentials in the config.ini file. Create this file in the project directory with the following structure:
[EMAIL]
EMAIL_ADDRESS = your_email@example.com
EMAIL_PASSWORD = your_email_passwordReplace your_email@example.com with your actual email address and your_email_password with your email account password.
AutoCV/
│
├── cv-automationScript.py # Main Flask application file
├── your_email_module.py # Module for handling email functionalities
├── config.ini # Configuration file for email credentials
├── README.md # Project documentation
└── requirements.txt # (Optional) List of dependencies
Contributions are welcome! If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Commit your changes and push to your branch.
- Create a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
Feel free to paste this directly into your repository. Let me know if you need any more assistance!