LWG — Light Weight Git

LWG (Light Weight Git) is a lightweight command-line tool that simplifies common Git workflows into short, easy-to-remember commands.

Instead of repeatedly typing multiple Git commands, LWG provides a simple interface for initializing repositories, committing changes, and pushing them to a remote repository.

---

Features

• Simple Git workflow
• Quick repository initialization
• One-command commit and push
• GitHub HTTPS authentication setup
• Clear error handling
• Lightweight Python CLI
• Uses your existing Git installation

---

Requirements

Before installing LWG, make sure you have:

• Python 3.10 or newer
• Git
• A GitHub account and repository if you want to push to GitHub

Check your installed versions:

python --version
git --version

---

Installation

Install LWG directly from PyPI:

python -m pip install lwg-git

Verify the installation:

lwg --version

You can also view the available commands:

lwg --help

---

Quick Start

1. Configure GitHub Authentication

If you use GitHub over HTTPS, configure your credentials:

lwg setup

LWG will ask for:

• GitHub username
• GitHub Personal Access Token (PAT)

Note: GitHub does not accept your normal account password for Git HTTPS authentication. Use a Personal Access Token instead.

If your Git authentication is already configured, you can skip this step.

---

2. Initialize a Repository

Navigate to your project directory:

cd my-project

Then run:

lwg i https://github.com/USERNAME/REPOSITORY.git

LWG performs the equivalent of:

git init
git add .
git commit -m "Initial commit"
git branch -M main
git remote add origin https://github.com/USERNAME/REPOSITORY.git
git push -u origin main

Your project is now initialized and pushed to the remote repository.

---

3. Push Changes

After making changes to your project, run:

lwg p "your commit message" main

For example:

lwg p "added authentication system" main

This performs:

git add .
git commit -m "added authentication system"
git push origin main

---

Commands

Command	Description
lwg --help	Display available commands
lwg --version	Display the installed version
lwg setup	Configure GitHub HTTPS credentials
lwg i <url>	Initialize a repository and connect it to a remote
lwg p <message> <branch>	Commit and push changes

---

Command Reference

lwg setup

Configure GitHub HTTPS credentials.

lwg setup

LWG will prompt you for your GitHub username and Personal Access Token.

Example:

LWG GitHub Setup
----------------
GitHub username: your-username
GitHub personal access token: ********

✓ GitHub credentials configured.
✓ Username: your-username
✓ Token saved.

---

lwg i <url>

Initialize the current directory as a Git repository and connect it to a remote repository.

Syntax

lwg i <repository-url>

Example

lwg i https://github.com/username/my-project.git

This command:

1. Initializes a Git repository.
2. Stages the project files.
3. Creates the initial commit.
4. Renames the branch to main.
5. Adds the remote repository as origin.
6. Pushes the main branch.

---

lwg p <message> <branch>

Stage, commit, and push changes to a remote branch.

Syntax

lwg p "<commit message>" <branch>

Example

lwg p "fix login bug" main

This is equivalent to:

git add .
git commit -m "fix login bug"
git push origin main

---

lwg --help

Display the command-line help:

lwg --help

---

lwg --version

Display the installed LWG version:

lwg --version

---

Typical Workflow

A typical first-time workflow looks like this:

cd my-project

lwg setup

lwg i https://github.com/username/my-project.git

After making changes:

lwg p "added new feature" main

And for another update:

lwg p "fixed authentication bug" main

---

Why LWG?

A typical Git repository setup requires multiple commands:

git init
git add .
git commit -m "Initial commit"
git branch -M main
git remote add origin URL
git push -u origin main

LWG simplifies this into:

lwg i URL

Likewise, a normal update requires:

git add .
git commit -m "message"
git push origin main

With LWG:

lwg p "message" main

LWG is designed to provide a simple interface for common Git workflows while keeping Git as the underlying version control system.

---

Development

Clone the repository:

git clone https://github.com/darkrho07/lwg.git
cd lwg

Install LWG in editable mode:

python -m pip install -e .

Run the development version:

lwg --help

---

Project Structure

lwg/
├── .github/
│   └── workflows/
│       └── release.yml
├── src/
│   └── lwg/
│       ├── __init__.py
│       ├── __main__.py
│       ├── auth.py
│       ├── cli.py
│       └── git.py
├── tests/
│   └── __init__.py
├── .gitignore
├── LICENSE
├── README.md
└── pyproject.toml

---

Contributing

Contributions, bug reports, and feature requests are welcome.

To contribute:

1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Test your changes.
5. Open a pull request.

For bugs and feature requests, open an issue on GitHub.

---

License

LWG is released under the MIT License.

See the LICENSE file for details.

---

Links

• PyPI
• GitHub Repository
• Issues

---

Author

Created and maintained by darkrho07.

If you find LWG useful, consider giving the repository a ⭐ on GitHub.