Metadata-Version: 2.1
Name: pixelfed-python-api
Version: 0.0.1
Summary: Python Library for Pixelfed
Author-email: Denis Cappellin <basset08.velars@icloud.com>
License: AGPL-3.0 license
Project-URL: Homepage, https://github.com/dcappellin/pixelfed-python-api
Keywords: pixelfed,python,api
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

Pixelfed Python API
===================
A limited Python library for Pixelfed (https://pixelfed.org). Only few methods are implemented.

Authentication
==============
You need a token from a Pixelfed instance. Navigate to /settings/applications on the Pixelfed instance and generate a new Personal Access Tokens. Use that token for authentication.
The token must be available in the environment variable PIXELFED_API_TOKEN.

Pixelfed Domain
===============
The domain can be stored in the environment variable PIXELFED_DOMAIN_URI or passed as a parameter to the ``Pixelfed()`` constructor.

Installing
===========

.. code-block:: bash

    pip install pixelfed-python-api

Usage
=====

.. code-block:: bash

    >>> from pixelfed_python_api import Pixelfed
    >>> pfi = Pixelfed().instance()
    >>> print(pfi['version'])
    '2.7.2 (compatible; Pixelfed 0.11.4)'
