Git2Local: Your Guide To Effortless Engineering Activity Reports

Oct 10, 2025 by ADMIN 65 views

Hey guys! 👋 Let's dive into something cool today: git2local, a Python script that's all about making your engineering life easier. This is an early working copy, so we're in the testing phase, but it's already shaping up to be super helpful for generating Engineering Activity Reports. I'm Ashant, and I'm stoked to walk you through it. Specifically, we'll be taking a look at the git2local script, its setup, and how it can streamline your workflow.

What is `git2local`?

At its core, git2local is a Python script designed to help you generate reports. It's particularly useful for engineers who need to track their activities, especially when working with projects that integrate with Odoo. The script fetches data from Git repositories and, optionally, Odoo to compile comprehensive reports. This means you spend less time manually logging your work and more time coding, which is a win-win, right?

Now, the script's main job is to make your life easier by automating the creation of activity reports. Instead of manually gathering data about your commits and tasks, git2local does it for you. It's a fantastic tool for keeping track of your progress on various projects. In other words, the script acts as a bridge, pulling information from different sources and assembling it into a useful report. Think of it as your personal assistant for project tracking, but with a technical twist.

The script's ability to handle Odoo integration is a standout feature, because a lot of engineering projects now incorporate ERP systems like Odoo. If you need to pull in data from Odoo to provide context for your Git activities, git2local can help you with that. This feature is especially helpful if you're working on projects that involve both code and business processes, ensuring that your reports provide a complete picture of your work.

How `git2local` Works

The script primarily interacts with your Git repository to gather information about your commits. It analyzes your commit messages, author details, and timestamps to build a chronological view of your activities. Moreover, the script can also integrate with Odoo. This integration allows it to pull data related to your tasks, such as task descriptions, statuses, and related project details. This is a game changer if you need a comprehensive view of both your code and project tasks.

Getting Started with `git2local`

Ready to get your hands dirty? Let's get git2local up and running. The setup is pretty straightforward, and I'll walk you through it step by step.

Prerequisites

Before we start, make sure you have the following:

Python: You need Python installed on your system. This script is written in Python, so that's a must.
Git: You'll need Git installed and configured. The script pulls data from your Git repositories, so make sure you're set up.
Access to a Git repository: Ensure that you have access to a Git repository that you want to analyze. This could be a local repository or one hosted on GitHub.

Installation

Clone the repository: First, clone the git2local repository from GitHub. Open your terminal and run:
```
git clone https://github.com/wapsol/git2local.git
cd git2local
```
Install dependencies: Navigate into the git2local directory and install the required Python packages. It's always a good idea to use a virtual environment to manage your dependencies. Run:
```
python -m venv .venv
source .venv/bin/activate  # For Linux/macOS
# or
.venv\Scripts\activate  # For Windows
pip install -r requirements.txt
```

Running `git2local`

With the script set up, let's see how to run it. The script provides a few options to customize the way it works.

Basic Usage

To get started, navigate to the git2local directory in your terminal and run the script. The --help option will show you the available options. Try:

./git2local --help

You should see a list of all the available parameters and how to use them. Now let's get into some specific commands.

Including Odoo Data

To include data from Odoo, you need to provide the Odoo database details. These details should be set in a .env file. For example:

ODOO_DATABASE_NAME=your_database_name
ODOO_USER=your_user
ODOO_PASSWORD=your_password

However, remember that the .env file is not committed to the repository. Instead, you'll find a .env.example file. You can use this as a template to create your own .env file and populate it with your Odoo credentials. Now, run the script with the --include-odoo option:

./git2local --include-odoo

Troubleshooting and Common Issues

If you run into any issues, here are a few things to check:

Environment variables: Double-check that your .env file is correctly set up with your Odoo credentials.
Odoo connection: If you're still unable to connect to Odoo, make sure that your Odoo instance is running and that the credentials are correct. I'll be available next week to help you out if you run into any roadblocks.
Git repository access: Ensure that the script has access to the Git repository. If you're using a private repository, make sure that your SSH keys are set up correctly.

Advanced Usage and Customization

Once you've got the basics down, you can start customizing git2local to fit your specific needs. The script has a few advanced options that provide more flexibility. For example, you might want to filter your reports by date range, author, or specific keywords. Here are a couple of ways to do it.

Filtering by Date Range

You can filter your reports by specifying start and end dates. This is particularly helpful when you need to focus on a specific period. To do this, use the --start-date and --end-date options. Dates should be in the format YYYY-MM-DD.

./git2local --start-date 2024-01-01 --end-date 2024-01-31

This command will generate a report that covers the month of January. This is helpful for monthly reports, or weekly check-ins. This is also a helpful way to keep your report from getting too lengthy.

Filtering by Author

If you need to see the contributions of a specific author, use the --author option. This is great when you need to review a single person's activities.

./git2local --author "Your Name"

Replace `