chore: finalize restructure and prep for PyPI packaging

Author: nelson-zack

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+exclude .env
+recursive-exclude tests *

README.md

@@ -1,5 +1,7 @@
 # Commit Companion
 
+[![PyPI version](https://badge.fury.io/py/commit-companion.svg)](https://badge.fury.io/py/commit-companion)
+
 **AI-powered Git commit assistant that summarizes staged changes using GPT.**  
 Save time, stay in flow, and write better commit messages — automatically.
 
@@ -18,37 +20,66 @@ Save time, stay in flow, and write better commit messages — automatically.
 
 ## Quick Start
 
-### 1. Clone the repo and install dependencies:
+### 1. Install via pip (recommended):
+
+```bash
+pip install commit-companion
+```
+
+Or, to install from source:
 
 ```bash
 git clone https://github.com/nelson-zack/commit-companion.git
 cd commit-companion
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements.txt
+pip install .
 ```
 
-### 2. Add your OpenAI key to .env:
-```bash 
+### 2. Add your OpenAI API key:
+
+Commit Companion requires access to the OpenAI API. You can provide your key in one of two ways:
+
+#### Option 1: `.env` file (for local use)
+
+```bash
 OPENAI_API_KEY=sk-...
 ```
 
+#### Option 2: Environment variable (for global use)
+
+Add to your shell config (`~/.zshrc`, `~/.bashrc`, etc):
+
+```bash
+export OPENAI_API_KEY="sk-..."
+```
+
+Then run:
+
+```bash
+source ~/.zshrc   # or ~/.bashrc
+```
+
 ### 3. Install CLI tool locally:
+
 ```bash
 pip install --editable .
 ```
 
 ## Usage
 
 ### CLI (manual):
+
 ```bash
 commit-companion suggest --tone casual --type feat
 ```
+
 Will output something like:
+
 ```bash
 feat: add basic functionality to README.md
 ```
+
 Example usage:
+
 ```bash
 git add <file>
 commit-companion suggest --tone casual --type feat
@@ -57,10 +88,13 @@ git push
 ```
 
 ### Git Hook (auto):
+
 Install the Git hook with:
+
 ```bash
 commit-companion install-hook
 ```
+
 This creates a .git/hooks/prepare-commit-msg script that auto-generates commit messages using GPT.
 By default, it uses --tone neutral and --type feat.
 
@@ -75,54 +109,64 @@ git push            # Push to remote
 #### Customize per commit:
 
 Override tone or type like this:
+
 ```bash
 TYPE=fix git commit
 TONE=funny git commit
 TYPE=fix TONE=funny git commit
 ```
 
 Uninstall the hook:
+
 ```bash
 commit-companion uninstall-hook
 ```
 
 ### Optional: Global Installation
 
 To use commit-companion from any repo without activating a virtual environment:
+
 #### 1. Install globally:
+
 ```bash
 pip install .
 ```
 
-#### 2.	Add your OpenAI key to your shell config (~/.zshrc or ~/.bashrc):
+#### 2. Add your OpenAI key to your shell config (~/.zshrc or ~/.bashrc):
+
 ```bash
 export OPENAI_API_KEY="sk-..."
 ```
 
-#### 3.	Ensure your Python bin path is on your system PATH:
+#### 3. Ensure your Python bin path is on your system PATH:
+
 ```bash
 export PATH="$PATH:/Library/Frameworks/Python.framework/Versions/3.12/bin"
 ```
 
-#### 4.	Reload your shell:
+#### 4. Reload your shell:
+
 ```bash
 source ~/.zshrc   # or ~/.bashrc
 ```
 
-#### 5.	Use it anywhere:
+#### 5. Use it anywhere:
+
 ```bash
 commit-companion install-hook
 ```
 
-
 ## Roadmap Ideas
+
 - Config file support (.commitcompanion.json)
 - VS Code extension
 - Web version / hosted API
-- PyPI distribution (pip install commit-companion)
+- ✅ PyPI distribution (available via `pip install commit-companion`)
 
 ## Why Use This?
+
 Writing commit messages breaks flow. Commit Companion helps you:
+
 - Stay focused on your code
 - Standardize commits with no effort
 - Impress your teammates with clear, consistent commit messages

commit_companion/__init__.py

@@ -1,17 +1,23 @@
-from setuptools import setup
+from setuptools import setup, find_packages
 
 setup(
     name='commit-companion',
     version='1.0.0',
-    py_modules=['cli', 'main', 'git_utils', 'ai_utils', 'utils'],
+    packages=find_packages(),
     install_requires=[
         'click',
         'openai',
         'python-dotenv',
     ],
     entry_points={
         'console_scripts': [
-            'commit-companion=cli:cli',
+            'commit-companion=commit_companion.cli:cli',
         ],
     },
+    author='Zack Nelson',
+    description='Generate AI-powered Git commit messages from diffs.',
+    long_description=open("README.md").read(),
+    long_description_content_type='text/markdown',
+    license='MIT',
+    python_requires='>=3.7',
 )