pixelfed-python-api


Namepixelfed-python-api JSON
Version 0.0.1 PyPI version JSON
download
home_page
SummaryPython Library for Pixelfed
upload_time2023-01-15 16:54:40
maintainer
docs_urlNone
author
requires_python>=3.7
licenseAGPL-3.0 license
keywords pixelfed python api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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)'

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pixelfed-python-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "pixelfed,python,api",
    "author": "",
    "author_email": "Denis Cappellin <basset08.velars@icloud.com>",
    "download_url": "https://files.pythonhosted.org/packages/8a/d6/7ab01240943777d04d6358365b6e09c04b816ce373d2c25ba5a52792b38f/pixelfed_python_api-0.0.1.tar.gz",
    "platform": null,
    "description": "Pixelfed Python API\n===================\nA limited Python library for Pixelfed (https://pixelfed.org). Only few methods are implemented.\n\nAuthentication\n==============\nYou 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.\nThe token must be available in the environment variable PIXELFED_API_TOKEN.\n\nPixelfed Domain\n===============\nThe domain can be stored in the environment variable PIXELFED_DOMAIN_URI or passed as a parameter to the ``Pixelfed()`` constructor.\n\nInstalling\n===========\n\n.. code-block:: bash\n\n    pip install pixelfed-python-api\n\nUsage\n=====\n\n.. code-block:: bash\n\n    >>> from pixelfed_python_api import Pixelfed\n    >>> pfi = Pixelfed().instance()\n    >>> print(pfi['version'])\n    '2.7.2 (compatible; Pixelfed 0.11.4)'\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0 license",
    "summary": "Python Library for Pixelfed",
    "version": "0.0.1",
    "split_keywords": [
        "pixelfed",
        "python",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c31f362d5c2ed0d1ef1d639f274d706939643cc484a354831912130ed8a3b10f",
                "md5": "4426570ea08133442ccd77cee12a9f21",
                "sha256": "37c817f1466bfc07a658a480b8c5212e1af75b91a4b16db272dfbb3a1bd05b32"
            },
            "downloads": -1,
            "filename": "pixelfed_python_api-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4426570ea08133442ccd77cee12a9f21",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 14744,
            "upload_time": "2023-01-15T16:54:39",
            "upload_time_iso_8601": "2023-01-15T16:54:39.480140Z",
            "url": "https://files.pythonhosted.org/packages/c3/1f/362d5c2ed0d1ef1d639f274d706939643cc484a354831912130ed8a3b10f/pixelfed_python_api-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8ad67ab01240943777d04d6358365b6e09c04b816ce373d2c25ba5a52792b38f",
                "md5": "f8bd1f62dbd6fa0f8d637f307f857073",
                "sha256": "4ef0176074f067b5ca6241278b25c5da3d1017ae1dcb0e0e561cd56c9ace41fc"
            },
            "downloads": -1,
            "filename": "pixelfed_python_api-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f8bd1f62dbd6fa0f8d637f307f857073",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 14398,
            "upload_time": "2023-01-15T16:54:40",
            "upload_time_iso_8601": "2023-01-15T16:54:40.762306Z",
            "url": "https://files.pythonhosted.org/packages/8a/d6/7ab01240943777d04d6358365b6e09c04b816ce373d2c25ba5a52792b38f/pixelfed_python_api-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-15 16:54:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pixelfed-python-api"
}
        
Elapsed time: 0.16947s