Skip to content

[COR-1983] README update #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewsy-opal merged 1 commit into from
Nov 27, 2024
Merged

[COR-1983] README update #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .openapi-generator/templates/README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: {{appVersion}}
- Package version: {{packageVersion}}
- [Releases](https://github.com/opalsecurity/opal-python/releases/)
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Generator version: {{generatorVersion}}
- Build package: {{generatorClass}}
{{#infoUrl}}

For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}

Expand All @@ -24,7 +25,7 @@ Python {{{generatorLanguageVersion}}}
### pip install
We recommend installing from [PyPI](https://pypi.org) using `pip`:
```sh
pip install {{{packageName}}}
pip install {{{projectName}}}
```

You can also install via git:
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Your Home For Developer Resources.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0.0
- [Releases](https://github.com/opalsecurity/opal-python/releases/)
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit [https://www.opal.dev/](https://www.opal.dev/)

## Requirements.
Expand All @@ -17,7 +18,7 @@ Python 3.8+
### pip install
We recommend installing from [PyPI](https://pypi.org) using `pip`:
```sh
pip install opal_security
pip install opal-security
```

You can also install via git:
Expand Down