datacrunch 1.14.0__tar.gz → 1.16.0__tar.gz

{datacrunch-1.14.0 → datacrunch-1.16.0}/PKG-INFO

@@ -1,42 +1,27 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: datacrunch
-Version: 1.14.0
+Version: 1.16.0
 Summary: Official Python SDK for DataCrunch Public API
-Home-page: https://github.com/DataCrunch-io
 Author: DataCrunch Oy
-Author-email: info@datacrunch.io
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Author-email: DataCrunch Oy <info@datacrunch.io>
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
-Requires-Python: >=3.10
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: requests>=2.25.1,<3
+Requires-Dist: dataclasses-json>=0.6.7
+Requires-Python: >=3.11
+Project-URL: Changelog, https://datacrunch-python.readthedocs.io/en/latest/changelog.html
+Project-URL: Documentation, https://datacrunch-python.readthedocs.io/
+Project-URL: Homepage, https://github.com/DataCrunch-io
+Project-URL: Repository, https://github.com/DataCrunch-io/datacrunch-python
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests<3,>=2.25.1
-Requires-Dist: dataclasses_json>=0.6.7
-Provides-Extra: dev
-Provides-Extra: test
-Requires-Dist: pytest<7,>=6.2.1; extra == "test"
-Requires-Dist: pytest-cov<3,>=2.10.1; extra == "test"
-Requires-Dist: pytest-responses<1,>=0.4.0; extra == "test"
-Requires-Dist: responses<1,>=0.12.1; extra == "test"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # DataCrunch Python SDK
 
@@ -56,10 +41,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).
@@ -122,63 +111,53 @@ 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:
+### Set up the local development environment
 
-  ```bash
-  python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate
-  ```
-
-  or if using [fish shell](https://fishshell.com/):
-
-  ```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
+### Run Tests
 
-We use pytest for testing.
-
-- 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'
 CLIENT_ID = 'your-id'
 
-# Create datcrunch client
+# Create datacrunch client
 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.
@@ -188,19 +167,14 @@ cd docs
 make html
 ```
 
-### Style Guide
-
-Use autopep8 for auto code formatting:
+### Code style
 
 ```bash
-# Install
-pip3 install autopep8
-
-# Apply to an entire directory
-autopep8 directory_name --recursive --in-place --pep8-passes 2000 --verbose
+# Lint
+uv run ruff check
 
-# Or a single file
-autopep8 file.py --in-place
+# Format code
+uv run ruff format
 ```
 
 ## Contact

{datacrunch-1.14.0 → datacrunch-1.16.0}/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,63 +86,53 @@ 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'
 CLIENT_ID = 'your-id'
 
-# Create datcrunch client
+# Create datacrunch client
 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.
@@ -148,19 +142,14 @@ cd docs
 make html
 ```
 
-### Style Guide
-
-Use autopep8 for auto code formatting:
+### Code style
 
 ```bash
-# Install
-pip3 install autopep8
-
-# Apply to an entire directory
-autopep8 directory_name --recursive --in-place --pep8-passes 2000 --verbose
+# Lint
+uv run ruff check
 
-# Or a single file
-autopep8 file.py --in-place
+# Format code
+uv run ruff format
 ```
 
 ## Contact