👌 IMPROVE: Contribution

Author: arre-ankit

CONTRIBUTION.md

@@ -14,8 +14,8 @@ This document provides instructions for setting up the development environment,
 
 1. **Clone the repository**:
    ```bash
-   git clone https://github.com/LangbaseInc/langbase-sdk-python
-   cd langbase-sdk-python
+   git clone https://github.com/LangbaseInc/langbase-python-sdk
+   cd langbase-python-sdk
    ```
 
 2. **Create and activate a virtual environment**:
@@ -31,8 +31,6 @@ This document provides instructions for setting up the development environment,
 
 3. **Install development dependencies**:
    ```bash
-   pip install -e ".[dev]"
-   # Or
    pip install -r requirements-dev.txt
    ```
 
@@ -48,12 +46,8 @@ This document provides instructions for setting up the development environment,
    black .
    isort .
    ```
-   
-6. Run the tests:
-
-## Running Tests
 
-The SDK uses pytest for testing. To run the tests:
+6. Run the tests:
 
 ```bash
 # Run all tests
@@ -66,19 +60,9 @@ pytest tests/test_langbase.py
 pytest --cov=langbase
 ```
 
-## Building the Package
-
-To build the package:
-
-```bash
-python -m build
-```
-
-This will create both source distributions and wheel distributions in the `dist/` directory.
 
-## Testing the Package Locally
+## Running and Testing Examples Locally
 
-You can test the package locally without publishing to PyPI:
 
 ```bash
 # Install in development mode
@@ -88,118 +72,50 @@ pip install -e .
 Then you can run examples:
 
 ```
-./venv/bin/python examples/pipes/pipes.run.py
-```
-
-## Publishing to PyPI
-
-### Prerequisites
-
-- A PyPI account
-- twine package (`pip install twine`)
-
-### Steps to Publish
-
-1. **Make sure your package version is updated**:
-   - Update the version number in `langbase/__init__.py`
-
-2. **Build the package**:
-   ```bash
-   python -m build
-   ```
-
-If it doesn't work, try installing the latest version of `build`:
-
-```bash
-pip install build
-```
-
-And then run:
-
-```bash
-./venv/bin/python -m build
-```
-
-3. **Check the package**:
-   ```bash
-   twine check dist/*
-   ```
-
-4. **Upload to TestPyPI (optional but recommended)**:
-   ```bash
-   twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-   ```
-
-5. **Test the TestPyPI package**:
-   ```bash
-   pip install --index-url https://test.pypi.org/simple/ langbase
-   ```
-
-6. **Upload to PyPI**:
-   ```bash
-   twine upload dist/*
-   ```
-
-## Automating Releases with GitHub Actions
-
-For automated releases, you can use GitHub Actions. Create a workflow file at `.github/workflows/publish.yml` with the following content:
-
-```yaml
-name: Publish to PyPI
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build twine
-      - name: Build and publish
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: |
-          python -m build
-          twine upload dist/*
+python examples/pipes/pipes.run.py
 ```
 
 ## Project Structure
 
 The project follows this structure:
 
 ```
-langbase-python/
-├── langbase/                   # Main package
-│   ├── __init__.py             # Package initialization
-│   ├── langbase.py             # Main client implementation
-│   ├── request.py              # HTTP request handling
-│   ├── errors.py               # Error classes
-│   ├── types.py                # Type definitions (not used)
-│   └── utils.py                # Utility functions
-│   └── workflow.py             # Workflow implementation
+langbase-python-sdk/
+├── langbase/                 # Main package
+│   ├── __init__.py           # Package initialization
+│   ├── errors.py             # Error classes
+│   ├── helper.py             # Helper functions
+│   ├── langbase.py           # Main client implementation
+│   ├── request.py            # HTTP request handling
+│   ├── types.py              # Type definitions
+│   ├── utils.py              # Utility functions
+│   └── workflow.py           # Workflow implementation
 ├── tests/                      # Test package
 │   ├── __init__.py             # Test package initialization
-│   ├── test_client.py          # Tests for the client
-│   ├── test_request.py         # Tests for request handling
+│   ├── conftest.py             # Test configuration
 │   ├── test_errors.py          # Tests for error classes
-│   └── test_utils.py           # Tests for utility functions
+│   ├── test_langbase_client.py # Tests for the client
+│   ├── test_memories.py        # Tests for memory functionality
+│   ├── test_pipes.py           # Tests for pipes
+│   ├── test_threads.py         # Tests for threads
+│   ├── test_tools.py           # Tests for tools
+│   ├── test_utilities.py       # Tests for utility functions
 │   └── test_workflow.py        # Tests for workflow
 ├── examples/                   # Example scripts
-├── setup.py                    # Package setup script
+│   ├── agent/                  # Agent examples
+│   ├── chunker/                # Chunker examples
+│   ├── embed/                  # Embed examples
+│   ├── memory/                 # Memory examples
+│   ├── parser/                 # Parser examples
+│   ├── pipes/                  # Pipe examples
+│   ├── threads/                # Thread examples
+│   ├── tools/                  # Tool examples
+│   └── workflow/               # Workflow examples
 ├── pyproject.toml              # Project configuration
 ├── requirements.txt            # Package dependencies
 ├── requirements-dev.txt        # Development dependencies
-├── LICENSE                     # MIT license
+├── LICENCE                     # MIT license
+├── CONTRIBUTION.md             # Contribution guidelines
 └── README.md                   # Main documentation
 ```
 
@@ -212,28 +128,3 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Package not found after installation**:
-   - Make sure your virtual environment is activated
-   - Try running `pip list` to confirm installation
-
-2. **Build errors**:
-   - Make sure you have the latest `build` package: `pip install --upgrade build`
-   - Check for syntax errors in your code
-
-3. **Test failures**:
-   - Run specific failing tests to get more details
-   - Check for API key issues if integration tests are failing
-
-### Getting Help
-
-If you encounter issues not covered here, please open an issue on GitHub with detailed information about the problem, including:
-
-- Your Python version
-- Your operating system
-- Any error messages
-- Steps to reproduce the issue