Metadata-Version: 2.5
Name: planvortex
Version: 0.0.1
Summary: Official Python client for the PlanVortex API
Project-URL: Homepage, https://planvortex.com
Project-URL: Documentation, https://planvortex.com/documentation
Project-URL: Repository, https://github.com/taliasoftworks/PlanVortexPython
Project-URL: Changelog, https://github.com/taliasoftworks/PlanVortexPython/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/taliasoftworks/PlanVortexPython/issues
Author-email: Talia Softworks <contact@planvortex.com>
License-Expression: MIT
License-File: LICENSE
Keywords: bluesky,facebook,instagram,linkedin,planvortex,publishing,scheduling,social media,tiktok
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
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 :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# planvortex

The official Python client for the [PlanVortex](https://planvortex.com) API — connect social
accounts, schedule and publish posts, read comments and messages, and pull stats, from Python.

> ## ⚠️ Not released yet
>
> **`0.0.1` is a placeholder.** It reserves the name on PyPI and proves the release pipeline; it
> contains no client and there is nothing useful to install yet. The first usable release will be
> `0.1.0`.
>
> If you need a PlanVortex client today, the Node one is published and complete:
> [`npm i planvortex`](https://www.npmjs.com/package/planvortex).
>
> Watch this repository to hear about `0.1.0`.

## What it will be

- **Synchronous and asynchronous**, same surface: `PlanVortex` and `AsyncPlanVortex`.
- **Typed**, from the same OpenAPI specification the API publishes at
  <https://planvortex.com/openapi.json>. Returned shapes are `TypedDict`, so `_id` stays `_id`.
- **One runtime dependency**, `httpx2` — a different package from `httpx` classic, so it will not
  collide with whatever your project already uses.
- **Server-side.** The `client_credentials` flow needs your `client_secret`. Connecting an account
  from a browser is what the temporal connect token is for.
- Python 3.10 and newer.

```python
from planvortex import PlanVortex

pv = PlanVortex()  # reads PLANVORTEX_CLIENT_ID and PLANVORTEX_CLIENT_SECRET

upload = pv.uploads.create(org_id, file="./sourdough.jpg")
pv.publications.create(
    org_id,
    account_id,
    social_network="instagram",
    text="New oven, new loaves",
    files=[upload["_id"]],
)
```

## Links

- [API documentation](https://planvortex.com/documentation)
- [Developers](https://planvortex.com/developers)
- [Node client](https://github.com/taliasoftworks/PlanVortexNode)
- [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md) · [Changelog](CHANGELOG.md)

MIT © Talia Softworks
