Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgoksal/employees-management-system
This Python module (employees.py) manages employees by defining classes for basic employee details, commission-paid employees, and hourly-paid employees. Each class encapsulates relevant attributes and methods for retrieving employee information and calculating weekly pay based on different pay structures (commission or hourly rates with overtime).
https://github.com/kgoksal/employees-management-system
Last synced: about 2 months ago
JSON representation
This Python module (employees.py) manages employees by defining classes for basic employee details, commission-paid employees, and hourly-paid employees. Each class encapsulates relevant attributes and methods for retrieving employee information and calculating weekly pay based on different pay structures (commission or hourly rates with overtime).
- Host: GitHub
- URL: https://github.com/kgoksal/employees-management-system
- Owner: KGoksal
- Created: 2024-08-18T03:25:18.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T01:57:51.000Z (5 months ago)
- Last Synced: 2024-08-23T02:57:06.125Z (5 months ago)
- Language: Python
- Homepage:
- Size: 204 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Employees-Management-System
This Python module (`employees.py`) defines classes to manage different types of employees within a company. It includes basic employee details and behaviors, as well as specific implementations for commission-paid and hourly-paid employees. This application is designed to facilitate efficient management of employee data and payroll within a company setting.
## Classes
### 1. Employee
Represents a basic employee with attributes for name and department. This class includes methods to retrieve and update these attributes.
**Methods:**
- `get_name()`: Retrieves the employee's name.
- `set_name(name)`: Sets the employee's name.
- `get_department()`: Retrieves the employee's department.
- `set_department(department)`: Sets the employee's department.
- `pay()`: Returns the base pay for the employee.
### 2. CommissionPaid
Inherits from `Employee` and represents an employee who receives a base rate plus commission based on sales.
**Additional Attributes:**
- `base_rate`: Base rate of pay.
- `sales`: Sales amount for commission calculation.
**Methods:**
- `get_base_rate()`
- `set_base_rate(base_rate)`
- `get_sales()`
- `set_sales(sales)`
- `pay()`: Calculates and returns the weekly pay, including commission, based on predefined commission rates.
### 3. HourlyPaid
Inherits from `Employee` and represents an employee who is paid based on an hourly rate and hours worked, including overtime.
**Additional Attributes:**
- `hourly_rate`: Hourly rate of pay.
- `hours`: Hours worked by the employee.
**Methods:**
- `get_hourly_rate()`
- `set_hourly_rate(hourly_rate)`
- `get_hours()`
- `set_hours(hours)`
- `pay()`: Calculates and returns the weekly pay, considering regular hours and overtime hours (if applicable).
## Usage
To use these classes, you can create instances of `Employee`, `CommissionPaid`, or `HourlyPaid` by initializing them with relevant details. Here's a simple example:
```python
# Example usage
from employees import Employee, CommissionPaid, HourlyPaid
# Create an instance of an employee
emp1 = Employee("John Doe", "Sales")
# Create an instance of a commission-paid employee
emp2 = CommissionPaid("Jane Smith", "Marketing", 1000.0, 15000)
# Create an instance of an hourly-paid employee
emp3 = HourlyPaid("Michael Brown", "Operations", 25.0, 45)
# Display information about the employees
print(emp1)
print(emp2)
print(emp3)
```
**In this example:**
- `emp1` is a basic employee with default pay.
- `emp2` is a commission-paid employee with a base rate and sales amount.
- `emp3` is an hourly-paid employee with an hourly rate and hours worked.
Each class provides its own `__str__()` method for a formatted string representation, displaying relevant details including weekly pay where applicable.
1. **Employee**:
- Represents basic employee details such as name and department.
- Provides methods for retrieving and updating these details.
- Computes base pay for the employee.
2. **CommissionPaid**:
- Inherits from `Employee`.
- Adds functionality for calculating pay based on a base rate and sales commission.
- Includes methods to manage base rate, sales amount, and compute weekly pay with commission.
3. **HourlyPaid**:
- Also inherits from `Employee`.
- Handles pay calculations based on an hourly rate and hours worked.
- Manages hourly rate, hours worked, and computes weekly pay considering regular and overtime hours.
### Usage:
- Users can create instances of `Employee`, `CommissionPaid`, or `HourlyPaid` to represent different employees.
- Each instance can be initialized with specific details and can compute its own weekly pay based on its pay structure (base rate + commission or hourly rate + overtime).
### Features:
- Encapsulates employee data and behaviors within each class.
- Provides clear methods for setting and retrieving employee attributes.
- Supports different pay structures (base rate + commission, hourly rate + overtime) catering to various employee types.
This module serves as a foundation for managing employee data and payroll calculations within a company, offering flexibility for customization based on specific business needs.