Metadata-Version: 2.4
Name: gopad
Version: 2.7.1
Summary: Gopad OpenAPI
License: Apache-2.0
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,Etherpad,Gopad
Author: Thomas Boerger
Author-email: thomas@webhippie.de
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=2.2.2)
Project-URL: Repository, https://github.com/gopad/gopad-python
Description-Content-Type: text/markdown

# Gopad: SDK for Python

[![General Workflow](https://github.com/gopad/gopad-python/actions/workflows/general.yml/badge.svg)](https://github.com/gopad/gopad-python/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#gopad:matrix.org](https://img.shields.io/badge/matrix-%23gopad%3Amatrix.org-7bc9a4.svg)](https://matrix.to/#/#gopad:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0581d0652d4d4dddb3fc353f74cd9bed)](https://app.codacy.com/gh/gopad/gopad-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![PyPI Version](https://badge.fury.io/py/gopad.svg)](https://badge.fury.io/py/gopad)

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

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

For more information, please visit [https://gopad.eu](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:

```console
pip install gopad@2.7.1
```

## Tests

```console
pytest
```

## Security

If you find a security issue please contact
[gopad@webhippie.de](mailto:gopad@webhippie.de) first.

## Generating

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

```console
mise trust
mise install
```

## Contributing

Generally we are following [conventional commits][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][semver] 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:

```console
pre-commit install --hook-type pre-commit --hook-type commit-msg
```

> `pre-commit` 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:

```console
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](https://github.com/tboerger)

## License

Apache-2.0

## Copyright

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

[generator]: https://openapi-generator.tech
[setuptools]: http://pypi.python.org/pypi/setuptools
[mise]: https://mise.jdx.dev/
[mise-install]: https://mise.jdx.dev/getting-started.html
[commits]: https://www.conventionalcommits.org/en/v1.0.0/
[semver]: https://semver.org/

