Skip to content

Commit bc87d85

Browse files
added README.md
1 parent c807db4 commit bc87d85

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Timesheet Helper
2+
3+
Timesheet Helper is a collection of Python scripts designed to process text-based timesheets copied from Microsoft Word. The scripts can remove time spans, calculate the duration of time spans, and format the timesheet for either email or timesheet entry purposes.
4+
5+
## Table of Contents
6+
7+
- [Timesheet Helper](#timesheet-helper)
8+
- [Table of Contents](#table-of-contents)
9+
- [Getting Started](#getting-started)
10+
- [Prerequisites](#prerequisites)
11+
- [Installation](#installation)
12+
- [Usage](#usage)
13+
- [Scripts](#scripts)
14+
- [remove\_times.py](#remove_timespy)
15+
- [timesheet\_helper.py](#timesheet_helperpy)
16+
- [timesheet.py](#timesheetpy)
17+
- [Contributing](#contributing)
18+
19+
## Getting Started
20+
21+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
22+
23+
### Prerequisites
24+
25+
Ensure you have Python installed on your machine. The scripts are written in Python 3.
26+
27+
```bash
28+
# Check Python version
29+
python --version
30+
```
31+
32+
### Installation
33+
34+
Clone the repository to your local machine.
35+
36+
```bash
37+
# Clone the repository
38+
git clone https://github.com/Christopher-C-Robinson/Timesheet_Helper.git
39+
```
40+
41+
## Usage
42+
43+
1. Copy your bulleted timesheet from Microsoft Word.
44+
2. Paste it within the `timesheet.py` script.
45+
3. Run the `timesheet.py` script.
46+
47+
```bash
48+
# Run the script
49+
python timesheet.py
50+
```
51+
52+
## Scripts
53+
54+
### remove_times.py
55+
56+
This script defines a function `remove_timespans` that removes time spans from the text.
57+
58+
### timesheet_helper.py
59+
60+
This script defines a function `replace_with_duration` that replaces time spans in the text with their corresponding durations.
61+
62+
### timesheet.py
63+
64+
This script imports functions from the other two scripts and processes a text-based timesheet.
65+
66+
## Contributing
67+
68+
If you would like to contribute to the Timesheet Helper project, please feel free to fork the repository, create a feature branch, and submit a pull request.

0 commit comments

Comments
 (0)