planpoint-sdk 0.0.2__tar.gz

planpoint_sdk-0.0.2/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.1
+Name: planpoint-sdk
+Version: 0.0.2
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Planpoint Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Planpoint%2FPython)
+[![pypi](https://img.shields.io/pypi/v/planpoint-sdk)](https://pypi.python.org/pypi/planpoint-sdk)
+
+The Planpoint Python library provides convenient access to the Planpoint APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install planpoint-sdk
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    token="YOUR_TOKEN",
+)
+client.authentication.login(
+    username="user@example.com",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from planpoint import AsyncPlanpointApi
+
+client = AsyncPlanpointApi(
+    token="YOUR_TOKEN",
+)
+
+
+async def main() -> None:
+    await client.authentication.login(
+        username="user@example.com",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from planpoint.core.api_error import ApiError
+
+try:
+    client.authentication.login(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.authentication.login(..., {
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.authentication.login(..., {
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## 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!
+

planpoint_sdk-0.0.2/README.md

@@ -0,0 +1,146 @@
+# Planpoint Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Planpoint%2FPython)
+[![pypi](https://img.shields.io/pypi/v/planpoint-sdk)](https://pypi.python.org/pypi/planpoint-sdk)
+
+The Planpoint Python library provides convenient access to the Planpoint APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install planpoint-sdk
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    token="YOUR_TOKEN",
+)
+client.authentication.login(
+    username="user@example.com",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from planpoint import AsyncPlanpointApi
+
+client = AsyncPlanpointApi(
+    token="YOUR_TOKEN",
+)
+
+
+async def main() -> None:
+    await client.authentication.login(
+        username="user@example.com",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from planpoint.core.api_error import ApiError
+
+try:
+    client.authentication.login(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.authentication.login(..., {
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.authentication.login(..., {
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from planpoint import PlanpointApi
+
+client = PlanpointApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## 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!

planpoint_sdk-0.0.2/pyproject.toml

@@ -0,0 +1,58 @@
+[tool.poetry]
+name = "planpoint-sdk"
+version = "0.0.2"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "planpoint", from = "src"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "^0.5.6"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

planpoint_sdk-0.0.2/src/planpoint/__init__.py

@@ -0,0 +1,89 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    Collection,
+    CommercialSpace,
+    CommercialSpaceStatus,
+    ErrorResponse,
+    Floor,
+    FloorFull,
+    Group,
+    GroupProject,
+    GroupsListResponse,
+    Lead,
+    LoginResponse,
+    Project,
+    ProjectCustomButtonTxt,
+    ProjectInternalUrLs,
+    ProjectSummary,
+    Unit,
+    UnitFull,
+    UnitFullStatus,
+    UnitModel,
+    UnitStatus,
+    UnitsListResponse,
+    UpdateFloorBody,
+    UpdateGroupBody,
+    UpdateProjectBody,
+    UpdateUnitBody,
+)
+from .errors import (
+    BadRequestError,
+    ForbiddenError,
+    InternalServerError,
+    MethodNotAllowedError,
+    NotFoundError,
+    UnauthorizedError,
+)
+from . import authentication, floors, groups, leads, projects, units
+from .client import AsyncPlanpointApi, PlanpointApi
+from .environment import PlanpointApiEnvironment
+from .floors import CreateFloorBodyProject
+from .units import CreateUnitBodyFloor
+from .version import __version__
+
+__all__ = [
+    "AsyncPlanpointApi",
+    "BadRequestError",
+    "Collection",
+    "CommercialSpace",
+    "CommercialSpaceStatus",
+    "CreateFloorBodyProject",
+    "CreateUnitBodyFloor",
+    "ErrorResponse",
+    "Floor",
+    "FloorFull",
+    "ForbiddenError",
+    "Group",
+    "GroupProject",
+    "GroupsListResponse",
+    "InternalServerError",
+    "Lead",
+    "LoginResponse",
+    "MethodNotAllowedError",
+    "NotFoundError",
+    "PlanpointApi",
+    "PlanpointApiEnvironment",
+    "Project",
+    "ProjectCustomButtonTxt",
+    "ProjectInternalUrLs",
+    "ProjectSummary",
+    "UnauthorizedError",
+    "Unit",
+    "UnitFull",
+    "UnitFullStatus",
+    "UnitModel",
+    "UnitStatus",
+    "UnitsListResponse",
+    "UpdateFloorBody",
+    "UpdateGroupBody",
+    "UpdateProjectBody",
+    "UpdateUnitBody",
+    "__version__",
+    "authentication",
+    "floors",
+    "groups",
+    "leads",
+    "projects",
+    "units",
+]

planpoint_sdk-0.0.2/src/planpoint/authentication/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+