uv-based instructions

Author: shamrin

CONTRIBUTING.md

@@ -8,6 +8,8 @@ You can open pull requests by following the steps:
 
 ## Code Contribution
 
+Prerequisite: install [`uv`](https://docs.astral.sh/uv/).
+
 1. Fork the `datacrunch-python` repo on GitHub.
 
 2. Clone your fork locally:
@@ -17,11 +19,10 @@ You can open pull requests by following the steps:
    cd datacrunch-python
    ```
 
-3. Create virtual environment & install this local copy into the virtual environment:
+3. Set up local environment and install dependencies:
 
    ```bash
-   python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate
-   python3 setup.py develop
+   uv sync
    ```
 
 4. Create a new branch:
@@ -40,27 +41,20 @@ You can open pull requests by following the steps:
 
 5. Make your local changes
 
-6. Install dependencies for test:
+6. Run tests:
 
    ```bash
-   pip3 install -e .[test]
-   pip3 install -U pytest
+   uv run pytest
    ```
 
-7. Run tests:
+7. Commit and push:
 
    ```bash
-   pytest
-   ```
-
-8. Commit and push:
-
-   ```bash
-   git commit .am "Detailed commit message"
+   git commit -am "Detailed commit message"
    git push origin {branch-name}
    ```
 
-9. Submit a pull request in GitHub.
+8. Submit a pull request in GitHub.
 
 ## Pull Request Guidelines
 
@@ -71,13 +65,21 @@ You can open pull requests by following the steps:
 
 To release a new version:
 
-1. Update version and push:
-```
-uv version --bump minor # also `major` or `patch`
-git commit -m v$(uv version --short)
-git tag v$(uv version --short)
-git push origin master
-git push --tags
-```
-2. [Draft and publish](https://github.com/DataCrunch-io/datacrunch-python/releases) a new release.
-3. Check that package is automatically published to [PyPI](https://pypi.org/project/datacrunch/) via [GitHub action](https://github.com/DataCrunch-io/datacrunch-python/actions/workflows/publish_package.yml).
+1. Bump version:
+   ```bash
+   uv version --bump minor # also `major` or `patch`
+   ```
+
+2. Update `CHANGELOG.md`
+
+3. Commit and push:
+   ```bash
+   git commit -m v$(uv version --short) CHANGELOG.md pyproject.toml
+   git tag v$(uv version --short)
+   git push origin master
+   git push --tags
+   ```
+
+4. [Draft and publish](https://github.com/DataCrunch-io/datacrunch-python/releases) a new release.
+
+5. Check that package is automatically published to [PyPI](https://pypi.org/project/datacrunch/) via [GitHub action](https://github.com/DataCrunch-io/datacrunch-python/actions/workflows/publish_package.yml).

README.md

@@ -16,10 +16,14 @@ DataCrunch's Public API documentation [is available here](https://api.datacrunch
 
 ## Getting Started - Using the SDK:
 
-- Install via pip:
+- Install:
 
   ```bash
+  # via pip
   pip3 install datacrunch
+
+  # via uv
+  uv add datacrunch
   ```
 
 - Generate your client credentials - [instructions in the public API docs](https://api.datacrunch.io/v1/docs#description/quick-start-guide).
@@ -82,54 +86,38 @@ DataCrunch's Public API documentation [is available here](https://api.datacrunch
 
 ## Development
 
-### Setting up the local development environment
-
-- Clone the repository:
-
-  ```bash
-  git clone
-  ```
-
-- Create local virtual environment:
-
-  ```bash
-  python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate
-  ```
-
-  or if using [fish shell](https://fishshell.com/):
+### Set up the local development environment
 
-  ```fish
-  python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate.fish
-  ```
+Prerequisite: install [`uv`](https://docs.astral.sh/uv/).
 
-- Install Dependencies:
+Clone the repository, create local environment and install dependencies:
 
   ```bash
-  pip3 install -e .[test]
-  pip3 install -U pytest
+  git clone git@github.com:DataCrunch-io/datacrunch-python.git
+  cd datacrunch-python
+  uv sync
   ```
 
-### Running Tests
-
-We use pytest for testing.
+### Run Tests
 
-- To execute all tests
+- Execute all tests
 
   ```bash
-  pytest
+  uv run pytest
   ```
 
-- To execute a single test file
+- Execute a single test file
 
   ```bash
-  pytest ./tests/unit_tests/test_file.py
+  uv run pytest ./tests/unit_tests/test_file.py
   ```
 
 ### Local Manual Testing
 
-Create this file in the root directory of the project:
+Create a file in the root directory of the project:
 
 ```python
+# example.py
 from datacrunch.datacrunch import DataCrunchClient
 
 CLIENT_SECRET = 'secret'
@@ -139,6 +127,12 @@ CLIENT_ID = 'your-id'
 datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1')
 ```
 
+Run it:
+
+```bash
+uv run python example.py
+```
+
 ### Generating the documentation
 
 If added a new service, create a documentation template under api/services for that service.