rajnish-dc-crystal 0.1.0

Automate Crystal HR punch in/out operations

Crystal HR Automation

A Python package to automate Crystal HR punch in/out operations with configurable delays and email notifications.

Features

• Automated punch in/out with configurable delays
• Email notifications for successful/failed operations
• Configurable via JSON config file
• Command-line interface for easy use
• Production-ready package structure

Installation

From PyPI (Recommended)

pip install rajnish-dc-crystal

From Source

1. Clone the repository:

   git clone https://github.com/yourusername/rajnish-dc-crystal.git
   cd rajnish-dc-crystal
   

2. Install in development mode:

   pip install -e .[dev]
   

Quick Start

1. Initialize configuration:

   crystal-hr config init
   

2. Edit the config file (usually at ~/.config/crystal_hr/config.json) with your credentials.

3. Perform a punch in:

   crystal-hr punch in --delay 5
   

4. Perform a punch out:

   crystal-hr punch out
   

Configuration

The configuration file is stored in ~/.config/crystal_hr/config.json by default. You can specify a different path using the --config option.

Example configuration:

{
    "hr_system": {
        "username": "your_username",
        "password": "your_password",
        "company_id": "1",
        "base_url": "https://desicrewdtrial.crystalhr.com"
    },
    "email": {
        "gmail_user": "[e-mail]",
        "gmail_app_password": "your_app_password",
        "recipient_email": "[e-mail]"
    },
    "behavior": {
        "default_delay_minutes": 0,
        "random_delay_max_minutes": 0
    }
}

Usage

Punch In/Out

# Punch in with a 5-minute delay
crystal-hr punch in --delay 5

# Punch out immediately
crystal-hr punch out

Configuration Management

# Initialize a new config file
crystal-hr config init

# Show current configuration
crystal-hr config show

Development

Setup

1. Clone the repository
2. Install development dependencies:

   pip install -e .[dev]
   

Running Tests

pytest

Code Formatting

black .
isort .

Type Checking

mypy .

License

MIT

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Disclaimer

This software is provided as-is, without any warranties. Use it responsibly and in compliance with your organization's policies.