dataquery-sdk 0.0.7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,13 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+
9
+ ## [0.0.7] - 2025-10-20
10
+ - Initial release of dataquery-sdk
11
+ - Parallel file download functionality with HTTP range requests
12
+ - Group download capabilities with intelligent rate limiting
13
+ - Comprehensive test suite with coverage reporting
@@ -0,0 +1,144 @@
1
+ # Contributing to DataQuery SDK
2
+
3
+ Thank you for your interest in contributing to the DataQuery SDK! This document provides guidelines and information for contributors.
4
+
5
+ ## Getting Started
6
+
7
+ ### Prerequisites
8
+
9
+ - Python 3.10 or higher
10
+ - [uv](https://github.com/astral-sh/uv) package manager
11
+ - Git
12
+
13
+ ### Development Setup
14
+
15
+ 1. Fork the repository on GitHub
16
+ 2. Clone your fork locally:
17
+ ```bash
18
+ git clone https://github.com/your-username/dataquery-sdk.git
19
+ cd dataquery-sdk
20
+ ```
21
+
22
+ 3. Install the project in development mode:
23
+ ```bash
24
+ uv sync --all-extras --dev
25
+ ```
26
+
27
+ 4. Run the tests to ensure everything is working:
28
+ ```bash
29
+ uv run pytest tests/ -v
30
+ ```
31
+
32
+ ## Development Workflow
33
+
34
+ ### Making Changes
35
+
36
+ 1. Create a new branch for your feature or bugfix:
37
+ ```bash
38
+ git checkout -b feature/your-feature-name
39
+ # or
40
+ git checkout -b bugfix/your-bugfix-name
41
+ ```
42
+
43
+ 2. Make your changes following the coding standards (see below)
44
+
45
+ 3. Add tests for your changes:
46
+ - Unit tests for new functionality
47
+ - Integration tests for API changes
48
+ - Update existing tests if needed
49
+
50
+ 4. Run the test suite:
51
+ ```bash
52
+ uv run pytest tests/ -v
53
+ ```
54
+
55
+ 5. Run linting and formatting:
56
+ ```bash
57
+ uv run black .
58
+ uv run isort .
59
+ uv run flake8 dataquery/ tests/
60
+ uv run mypy dataquery/
61
+ ```
62
+
63
+ 6. Commit your changes with a descriptive message:
64
+ ```bash
65
+ git add .
66
+ git commit -m "Add feature: brief description of changes"
67
+ ```
68
+
69
+ 7. Push your branch and create a pull request
70
+
71
+ ### Coding Standards
72
+
73
+ - **Python Style**: Follow PEP 8
74
+ - **Formatting**: Use Black for code formatting
75
+ - **Import Sorting**: Use isort for import organization
76
+ - **Linting**: Use flake8 for code quality checks
77
+ - **Type Hints**: Use mypy for type checking
78
+ - **Docstrings**: Follow Google docstring format
79
+
80
+ ### Testing
81
+
82
+ - Write tests for all new functionality
83
+ - Maintain or improve test coverage
84
+ - Use descriptive test names
85
+ - Test both success and failure cases
86
+ - Mock external dependencies
87
+
88
+ ### Documentation
89
+
90
+ - Update docstrings for new functions/classes
91
+ - Update README.md if adding new features
92
+ - Update CHANGELOG.md for user-facing changes
93
+ - Add examples for new functionality
94
+
95
+ ## Pull Request Process
96
+
97
+ 1. Ensure all tests pass
98
+ 2. Ensure code follows style guidelines
99
+ 3. Update documentation as needed
100
+ 4. Add your changes to CHANGELOG.md
101
+ 5. Create a pull request with a clear description
102
+ 6. Request review from maintainers
103
+
104
+ ### Pull Request Template
105
+
106
+ When creating a pull request, please fill out the template with:
107
+ - Description of changes
108
+ - Type of change (bug fix, feature, etc.)
109
+ - Testing performed
110
+ - Any breaking changes
111
+ - Additional notes
112
+
113
+ ## Issue Reporting
114
+
115
+ When reporting bugs or requesting features:
116
+
117
+ - Use the provided issue templates
118
+ - Provide clear reproduction steps for bugs
119
+ - Include environment information
120
+ - Add code examples when relevant
121
+
122
+ ## Release Process
123
+
124
+ Releases are handled automatically through GitHub Actions:
125
+
126
+ 1. Create a git tag with version number (e.g., `v1.0.0`)
127
+ 2. Push the tag to trigger the release workflow
128
+ 3. The workflow will build, test, and publish to PyPI
129
+
130
+ ## Code of Conduct
131
+
132
+ - Be respectful and inclusive
133
+ - Focus on constructive feedback
134
+ - Help others learn and grow
135
+ - Follow the project's coding standards
136
+
137
+ ## Questions?
138
+
139
+ If you have questions about contributing, please:
140
+ - Open an issue with the "question" label
141
+ - Check existing issues and discussions
142
+ - Contact the maintainers
143
+
144
+ Thank you for contributing to DataQuery SDK!
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,28 @@
1
+ include README.md
2
+ include LICENSE
3
+ include CHANGELOG.md
4
+ include CONTRIBUTING.md
5
+ include requirements.txt
6
+ include requirements-dev.txt
7
+ include pyproject.toml
8
+ include .env.template
9
+
10
+ # Include package data
11
+ recursive-include dataquery *.py
12
+ recursive-include dataquery *.typed
13
+
14
+ # Exclude development and testing files
15
+ recursive-exclude tests *
16
+ recursive-exclude examples *
17
+ recursive-exclude docs *
18
+ exclude .gitignore
19
+ exclude .pre-commit-config.yaml
20
+ exclude tox.ini
21
+ exclude pytest.ini
22
+ exclude mypy.ini
23
+ exclude .coverage
24
+ exclude coverage.xml
25
+ recursive-exclude * __pycache__
26
+ recursive-exclude * *.py[co]
27
+ recursive-exclude * *.so
28
+ recursive-exclude * *.dylib