From af72b857bdabb7f8dd2b5897902004ff8331906f Mon Sep 17 00:00:00 2001 From: Zach Kirsch Date: Mon, 24 Apr 2023 22:24:05 -0400 Subject: [PATCH] Initial commit --- .fernignore | 3 +++ README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .fernignore create mode 100644 README.md diff --git a/.fernignore b/.fernignore new file mode 100644 index 0000000..43ca0d2 --- /dev/null +++ b/.fernignore @@ -0,0 +1,3 @@ +# Specify files that shouldn't be modified by Fern + +README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7437b6e --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ + +# {Company} Python Library + +[![pypi](https://img.shields.io/pypi/v/{company}.svg)](https://pypi.python.org/pypi/{company}) +[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) + +## Documentation + +API documentation is available at <{docs_url}>. + +## Usage + +Check out the [sample app](.sample-app/app.py) which consumes this SDK! + +```python +TODO +``` + +## Beta status + +This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. + +## Contributing + +While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us! + +On the other hand, contributions to the README are always very welcome!