Metadata-Version: 2.1
Name: writefreely-py
Version: 1.2.0
Summary: A Python package wrapping the WriteFreely / Write.as API
Home-page: https://github.com/adbenitez/writefreely-py
Author: adbenitez
Author-email: adbenitez@nauta.cu
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.26.0)
Provides-Extra: dev
Requires-Dist: requests (>=2.26.0) ; extra == 'dev'
Requires-Dist: pytest (>=6.2.5) ; extra == 'dev'
Requires-Dist: requests-mock (>=1.9.3) ; extra == 'dev'
Requires-Dist: black (>=21.8b0) ; extra == 'dev'
Requires-Dist: mypy (>=0.910) ; extra == 'dev'
Requires-Dist: isort (>=5.9.3) ; extra == 'dev'
Requires-Dist: pylint (>=2.10.2) ; extra == 'dev'
Requires-Dist: pylama (>=7.7.1) ; extra == 'dev'
Requires-Dist: types-pkg-resources (>=0.1.3) ; extra == 'dev'
Requires-Dist: types-requests (>=2.25.6) ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest (>=6.2.5) ; extra == 'test'
Requires-Dist: requests-mock (>=1.9.3) ; extra == 'test'

# WriteFreely

[![Latest Release](https://img.shields.io/pypi/v/writefreely-py.svg)](https://pypi.org/project/writefreely-py)
[![Supported Versions](https://img.shields.io/pypi/pyversions/writefreely-py.svg)](https://pypi.org/project/writefreely-py)
[![Downloads](https://pepy.tech/badge/writefreely-py)](https://pepy.tech/project/writefreely-py)
[![License](https://img.shields.io/pypi/l/writefreely-py.svg)](https://pypi.org/project/writefreely-py)
[![CI](https://github.com/adbenitez/writefreely-py/actions/workflows/python-ci.yml/badge.svg)](https://github.com/adbenitez/writefreely-py/actions/workflows/python-ci.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A Python package that wraps the [WriteFreely](https://writefreely.org) API, for use in your Python projects.

## Install

```
pip install writefreely-py
```

## Quick Start

```python
import writefreely as wf

# default WriteFreely instance is "https://write.as"
c = wf.client(user="foo", password="bar")

# create a post
post = c.create_post(title="Hello World!", body="Hello from **Python**")

print(f"See your post at: {c.host}/{post['slug']}")

# discard current session
c.logout()
```

Too see what extra parameters some functions accept and response structure, check:
https://developers.write.as/docs/api/

## Examples

Check the [examples folder](https://github.com/adbenitez/writefreely-py/tree/main/examples) for more code examples.


