https://github.com/adbenitez/writefreely-py

A Python package wrapping the WriteFreely / Write.as API
https://github.com/adbenitez/writefreely-py

api python writefreely

Last synced: about 2 months ago
JSON representation

A Python package wrapping the WriteFreely / Write.as API

• Host: GitHub
• URL: https://github.com/adbenitez/writefreely-py
• Owner: adbenitez
• License: mit
• Created: 2021-01-07T03:56:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T16:57:11.000Z (over 2 years ago)
• Last Synced: 2025-03-24T17:53:28.573Z (2 months ago)
• Topics: api, python, writefreely
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.