polars-api 0.1.1__py3-none-any.whl
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,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Diego Garcia Lozano
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: polars-api
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Polars extension for dealing with REST APIs
|
|
5
|
+
Author-email: Diego Garcia Lozano <diegoglozano96@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://diegoglozano.github.io/polars-api/
|
|
7
|
+
Project-URL: Repository, https://github.com/diegoglozano/polars-api
|
|
8
|
+
Project-URL: Documentation, https://diegoglozano.github.io/polars-api/
|
|
9
|
+
Keywords: python
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
19
|
+
Requires-Python: <4.0,>=3.9
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Requires-Dist: httpx>=0.28.1
|
|
23
|
+
Requires-Dist: polars>=1.19.0
|
|
24
|
+
|
|
25
|
+
# polars-api
|
|
26
|
+
|
|
27
|
+
[](https://img.shields.io/github/v/release/diegoglozano/polars-api)
|
|
28
|
+
[](https://github.com/diegoglozano/polars-api/actions/workflows/main.yml?query=branch%3Amain)
|
|
29
|
+
[](https://codecov.io/gh/diegoglozano/polars-api)
|
|
30
|
+
[](https://img.shields.io/github/commit-activity/m/diegoglozano/polars-api)
|
|
31
|
+
[](https://img.shields.io/github/license/diegoglozano/polars-api)
|
|
32
|
+
|
|
33
|
+
Polars extension for dealing with REST APIs
|
|
34
|
+
|
|
35
|
+
- **Github repository**: <https://github.com/diegoglozano/polars-api/>
|
|
36
|
+
- **Documentation** <https://diegoglozano.github.io/polars-api/>
|
|
37
|
+
|
|
38
|
+
## Getting started with your project
|
|
39
|
+
|
|
40
|
+
### 1. Create a New Repository
|
|
41
|
+
|
|
42
|
+
First, create a repository on GitHub with the same name as this project, and then run the following commands:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
git init -b main
|
|
46
|
+
git add .
|
|
47
|
+
git commit -m "init commit"
|
|
48
|
+
git remote add origin git@github.com:diegoglozano/polars-api.git
|
|
49
|
+
git push -u origin main
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 2. Set Up Your Development Environment
|
|
53
|
+
|
|
54
|
+
Then, install the environment and the pre-commit hooks with
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
make install
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
This will also generate your `uv.lock` file
|
|
61
|
+
|
|
62
|
+
### 3. Run the pre-commit hooks
|
|
63
|
+
|
|
64
|
+
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
uv run pre-commit run -a
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 4. Commit the changes
|
|
71
|
+
|
|
72
|
+
Lastly, commit the changes made by the two steps above to your repository.
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
git add .
|
|
76
|
+
git commit -m 'Fix formatting issues'
|
|
77
|
+
git push origin main
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
You are now ready to start development on your project!
|
|
81
|
+
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
|
|
82
|
+
|
|
83
|
+
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
|
|
84
|
+
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
|
|
85
|
+
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
|
|
86
|
+
|
|
87
|
+
## Releasing a new version
|
|
88
|
+
|
|
89
|
+
- Create an API Token on [PyPI](https://pypi.org/).
|
|
90
|
+
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/diegoglozano/polars-api/settings/secrets/actions/new).
|
|
91
|
+
- Create a [new release](https://github.com/diegoglozano/polars-api/releases/new) on Github.
|
|
92
|
+
- Create a new tag in the form `*.*.*`.
|
|
93
|
+
|
|
94
|
+
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
polars_api-0.1.1.dist-info/LICENSE,sha256=Ms_a-6jJtWdrIBCOaYS_hKFCODG2QXHcNgsQJnbujnA,1076
|
|
2
|
+
polars_api-0.1.1.dist-info/METADATA,sha256=kflG9Gkj7WD5rRZYZLx1JzCXHALbtQGLug9nHtvjMlQ,4046
|
|
3
|
+
polars_api-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
|
|
4
|
+
polars_api-0.1.1.dist-info/top_level.txt,sha256=8jrlIZHjbDXkT8co6HdxDmJ8hbSrMCCyUTF5XpxAc_w,11
|
|
5
|
+
polars_api-0.1.1.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
polars_api
|