Skip to content

Commit a5f76e3

Browse files
committed
docs: update license
1 parent f035944 commit a5f76e3

File tree

3 files changed

+39
-3
lines changed

3 files changed

+39
-3
lines changed

LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
MIT License
22

3+
Copyright (c) 2023 zztkm
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.
22+
23+
24+
Below is the original software license.
25+
326
Copyright (c) 2022 Kyle Conroy
427

528
Permission is hereby granted, free of charge, to any person obtaining a copy

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ generate: sqlc.yaml
2121

2222
.PHONY: release
2323
release: dist/sqlc-gen-python-orm.wasm dist/sqlc-gen-python-orm.wasm.sha256
24+
gh release create "v${VERSION}" dist/sqlc-gen-python-orm.wasm dist/sqlc-gen-python-orm.wasm.sha256
25+
26+
.PHONY: release
27+
release-overwrite: dist/sqlc-gen-python-orm.wasm dist/sqlc-gen-python-orm.wasm.sha256
2428
gh release delete -y --cleanup-tag "v${VERSION}"
2529
gh release create "v${VERSION}" dist/sqlc-gen-python-orm.wasm dist/sqlc-gen-python-orm.wasm.sha256
2630

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,24 @@
22

33
sqlc-gen-python-orm is a plugin for [sqlc](https://sqlc.dev/) that generates an ORM (now, support SQLAlchemy only) for Python.
44

5+
This softwaer forked from [sqlc-gen-python](https://github.com/sqlc-dev/sqlc-gen-python) and modified to generate ORM.
6+
57
## Usage
68

9+
get sha256 hash of wasm file
10+
11+
```bash
12+
curl -sSL https://github.com/zztkm/sqlc-gen-python-orm/releases/download/v0.0.1/sqlc-gen-python-orm.wasm.sha256
13+
```
14+
15+
add plugin to sqlc.yaml
716
```yaml
817
version: '2'
918
plugins:
1019
- name: py
1120
wasm:
12-
url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.1.0.wasm
13-
sha256: ef58f143a8c116781091441770c7166caaf361dd645f62b8f05f462e9f95c3b2
21+
url: https://github.com/zztkm/sqlc-gen-python-orm/releases/download/v0.0.1/sqlc-gen-python-orm.wasm
22+
sha256: <sha256 hash>
1423
sql:
1524
- schema: "schema.sql"
1625
queries: "query.sql"
@@ -19,7 +28,7 @@ sql:
1928
- out: src/authors
2029
plugin: py
2130
options:
22-
package: authors
31+
package: .
2332
emit_sync_querier: true
2433
emit_async_querier: true
2534
```

0 commit comments

Comments
 (0)