Skip to content

refactor(setup): optimize cfoundation setup process and improve documentation#21

Merged
guycipher merged 1 commit intomasterfrom
refactor/cfoundation-setup-process
Jan 14, 2025
Merged

refactor(setup): optimize cfoundation setup process and improve documentation#21
guycipher merged 1 commit intomasterfrom
refactor/cfoundation-setup-process

Conversation

@imprvhub
Copy link
Copy Markdown
Contributor

Overview

This PR optimizes the setup process for TidesDB Python bindings by implementing a sparse checkout of the C foundation repository, ensuring only essential files are cloned.

Changes

  • Modified setup scripts (setup.sh and setup.ps1) to:

    • Use git sparse checkout for cfoundation cloning
    • Only clone files required for building Python bindings
  • Updated README to:

    • Add clear instructions for virtual environment activation
    • Document the automated vs manual steps in setup process
    • Include OS-specific commands for venv activation

Related Issue

Closes #20

Testing Done

  • Tested setup process on Linux/macOS
  • Tested setup process on Windows
  • Verified all excluded files are properly filtered
  • Confirmed Python bindings build and install correctly
  • Validated virtual environment creation and activation

…entation

- Implement sparse checkout for cfoundation cloning to exclude unnecessary files
- Add clear instructions for virtual environment activation in README
- Only clone essential files required for Python bindings

Closes #20
@guycipher
Copy link
Copy Markdown
Member

Looks good.

@guycipher guycipher merged commit 55e8529 into master Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Optimize C Foundation Setup Process

2 participants