Skip to content

Commit 08304d1

Browse files
committed
update license and readme
1 parent d6cb6e9 commit 08304d1

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

LICENSE

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

3+
Copyright (c) 2025 tkfoss
34
Copyright (c) 2022 Jared Evans
45

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

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,38 +17,31 @@
1717

1818
This tool generates an OpenAPI V3 file from either a `serverless.yml` file or directly from your project's Pydantic models. It is a standalone Python application that can produce a complete OpenAPI specification for your serverless project or any Python application that uses Pydantic for data validation.
1919

20-
## Install
20+
## Use
2121

22-
This tool requires Python 3.8+.
22+
Not yet on PyPi - install from git
2323

24-
First, ensure you have the necessary Python packaging tools installed:
2524
```bash
26-
pip install build
25+
pip install git+https://github.com/tkfoss/python-serverless-openapi-documentation.git
2726
```
2827

29-
Then, build the package from the root of this repository:
30-
```bash
31-
python -m build
32-
```
28+
or build and install from source:
3329

34-
This will create a `dist` directory containing the installable package. You can install it using pip:
3530
```bash
31+
pip install build
32+
python -m build
3633
pip install dist/serverless_openapi_generator-1.0.0-py3-none-any.whl
3734
```
3835

39-
## Usage
40-
41-
Once installed, you can use the `openapi-gen` command-line tool.
42-
43-
### Running from GitHub
36+
or run as `uv` tool:
4437

45-
You can also run the tool directly from GitHub using `uvx`:
4638
```bash
4739
uvx --from git+https://github.com/tkfoss/python-serverless-openapi-documentation.git openapi-gen path/to/your/serverless.yml openapi.json
4840
```
41+
4942
For more information on running tools with `uv`, see the [official documentation](https://docs.astral.sh/uv/guides/tools/#running-tools).
5043

51-
**To Run:**
44+
**CLI:**
5245
```bash
5346
openapi-gen openapi.json --serverless-yml-path path/to/your/serverless.yml
5447
```

0 commit comments

Comments
 (0)