Gopad: SDK for Python

This repository provides a client SDK for Python. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0-alpha1
• Package version: 3.1.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://gopad.eu

Requirements

Python 3.10+

Installation

If you want to use one of the versions released via PyPi you just need to execute the following command within your project directory, after that you can import it as other libraries:

pip install gopad@3.1.0

Tests

pytest

Security

If you find a security issue please contact gopad@webhippie.de first.

Generating

We use mise to manage all required tools and their versions. Install it by following the official installation instructions, then run the following commands inside the repository to activate mise and install all tools defined in mise.toml:

mise trust
mise install

Contributing

Generally we are following conventional commits when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

prek install --hook-type pre-commit --hook-type commit-msg

prek is managed by mise and will be available after mise install.

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

Authors

• Thomas Boerger

License

Apache-2.0

Copyright

Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>