fast-webflow 0.1.1

A client library to communicate with the WebFlow API

Welcome to fast-webflow

a WebFlow CMS API Client in Python

This Python library provides an intuitive and fast interface over WebFlow's API. It simplifies the process of integrating your Python applications with the WebFlow content management system (CMS), allowing you to create, read, update, and delete items within your WebFlow collections.

Check out an example website built with the help of fast-webflow: liguriasegreta.com

DISCLAIMER: This is an unofficial abstraction over WebFlow's API and I am not associated with the WebFlow team.

Roadmap

• Add e-commerce functionality
• Add membership functionality
• Add tests
• Finish documentation
• Publish to PyPi

Features

• Authenticate with the WebFlow API using your API key
• Fetch collection data and items from WebFlow
• Create, update, and delete items within WebFlow collections
• Search for items within collections using filter parameters
• Handle pagination for large datasets
• Retrieve collection schema and field information
• Upload files to WebFlow

Installation

You can install the Python WebFlow CMS API Client library using pip:

pip install webflow-api

Getting Started

1. Obtain an API key from WebFlow by following their API Access Token.
2. Import the WebFlow class from the webflow module:

from webflow import WebFlow

3. Initialize the WebFlow client with your API key:

api_key = 'YOUR_API_KEY'
client = WebFlow(api_key)

4. Start interacting with the WebFlow API using the provided methods. For example, to fetch all items from a collection:

collection_id = 'COLLECTION_ID'
items = client.get_collection_items(collection_id)
for item in items:
    print(item)

Contributing

Contributions to the Python WebFlow CMS API Client library are welcome! If you encounter any bugs, have suggestions, or would like to contribute new features, please feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the GNU GPLv3 License. See the LICENSE file for more information.