pywykop3


Namepywykop3 JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/KaiserMovet/pywykop3
SummaryWykop v2 REST API Client
upload_time2023-03-19 22:58:23
maintainer
docs_urlNone
authorMateusz Rynkiewicz
requires_python
licenseMIT
keywords wykop
VCS
bugtrack_url
requirements requests
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # pywykop3

Python REST API Client for Wykop2 (via api v3)

[![Pylint](https://github.com/KaiserMovet/pywykop3/actions/workflows/pylint.yml/badge.svg)](https://github.com/KaiserMovet/pywykop3/actions/workflows/pylint.yml)
[![Create Release](https://github.com/KaiserMovet/pywykop3/actions/workflows/create_release.yml/badge.svg)](https://github.com/KaiserMovet/pywykop3/actions/workflows/create_release.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Full documentation can be found [HERE](https://kaisermovet.github.io/pywykop3/index.html)
API documentation can be found [HERE](https://kaisermovet.github.io/pywykop3/api.html)

## Usage

    from pywykop3 import WykopAPI

    # Without login
    api = WykopAPI(key=key, secret=secret)

    # User logged in
    api = WykopAPI(refresh_token=refresh_token)

    list_of_users = api.get_entry_comment_votes(70432439, 249723413)

## Obtaining Refresh Token

1.  Execute code:

        from pywykop3 import WykopAPI
        api = WykopAPI(key=key, secret=secret)
        url = api.connect()
        print(url)

2.  Open url, log into your accout
3.  Allow access to your account
4.  Copy refresh token from url ('rtoken' variable)

## Available methods

- ❌ - Not tested
- ✔️ - Tested
- ⛔ - Unable to test

### Users

| Method                                                                                                                 | Tested? |
| ---------------------------------------------------------------------------------------------------------------------- | ------- |
| [get_users_autocomplete](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_users_autocomplete) | ✔️      |

### Tags

| Method                                                                                                                         | Tested? |
| ------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [get_tags_popular](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_popular)                     | ❌      |
| [get_tags_popular_user_tags](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_popular_user_tags) | ❌      |
| [get_tags_related](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_related)                     | ❌      |
| [get_tag](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag)                                       | ❌      |
| [put_tag](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_tag)                                       | ❌      |
| [get_tag_stream](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_stream)                         | ❌      |
| [get_tag_newer](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_newer)                           | ❌      |
| [get_tag_users](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_users)                           | ❌      |
| [post_tag_user](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_tag_user)                           | ❌      |
| [delete_tag_user](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_tag_user)                       | ❌      |

### Mikroblog

| Method                                                                                                         | Tested? |
| -------------------------------------------------------------------------------------------------------------- | ------- |
| [get_entries](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entries)               | ❌      |
| [post_entry](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry)                 | ✔️      |
| [get_entry_by_id](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_by_id)       | ✔️      |
| [put_entry](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_entry)                   | ✔️      |
| [delete_entry_by_id](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_by_id) | ✔️      |
| [get_entry_votes](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_votes)       | ✔️      |
| [post_entry_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_vote)       | ⛔      |
| [delete_entry_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_vote)   | ⛔      |
| [get_entries_newer](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entries_newer)   | ❌      |

### Mikroblog - komentarze

| Method                                                                                                                       | Tested? |
| ---------------------------------------------------------------------------------------------------------------------------- | ------- |
| [get_entry_comments](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comments)               | ❌      |
| [post_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_comment)               | ❌      |
| [get_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comment)                 | ❌      |
| [put_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_entry_comment)                 | ❌      |
| [delete_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_comment)           | ❌      |
| [get_entry_comment_votes](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comment_votes)     | ❌      |
| [post_entry_comment_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_comment_vote)     | ❌      |
| [delete_entry_comment_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_comment_vote) | ❌      |

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/KaiserMovet/pywykop3",
    "name": "pywykop3",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "WYKOP",
    "author": "Mateusz Rynkiewicz",
    "author_email": "rynkiewiczmate@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/67/8030805318b7028cacd8283e697b2f967dca48b0931faf84c2e094e461c7/pywykop3-0.5.0.tar.gz",
    "platform": null,
    "description": "# pywykop3\n\nPython REST API Client for Wykop2 (via api v3)\n\n[![Pylint](https://github.com/KaiserMovet/pywykop3/actions/workflows/pylint.yml/badge.svg)](https://github.com/KaiserMovet/pywykop3/actions/workflows/pylint.yml)\n[![Create Release](https://github.com/KaiserMovet/pywykop3/actions/workflows/create_release.yml/badge.svg)](https://github.com/KaiserMovet/pywykop3/actions/workflows/create_release.yml)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nFull documentation can be found [HERE](https://kaisermovet.github.io/pywykop3/index.html)\nAPI documentation can be found [HERE](https://kaisermovet.github.io/pywykop3/api.html)\n\n## Usage\n\n    from pywykop3 import WykopAPI\n\n    # Without login\n    api = WykopAPI(key=key, secret=secret)\n\n    # User logged in\n    api = WykopAPI(refresh_token=refresh_token)\n\n    list_of_users = api.get_entry_comment_votes(70432439, 249723413)\n\n## Obtaining Refresh Token\n\n1.  Execute code:\n\n        from pywykop3 import WykopAPI\n        api = WykopAPI(key=key, secret=secret)\n        url = api.connect()\n        print(url)\n\n2.  Open url, log into your accout\n3.  Allow access to your account\n4.  Copy refresh token from url ('rtoken' variable)\n\n## Available methods\n\n- \u274c - Not tested\n- \u2714\ufe0f - Tested\n- \u26d4 - Unable to test\n\n### Users\n\n| Method                                                                                                                 | Tested? |\n| ---------------------------------------------------------------------------------------------------------------------- | ------- |\n| [get_users_autocomplete](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_users_autocomplete) | \u2714\ufe0f      |\n\n### Tags\n\n| Method                                                                                                                         | Tested? |\n| ------------------------------------------------------------------------------------------------------------------------------ | ------- |\n| [get_tags_popular](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_popular)                     | \u274c      |\n| [get_tags_popular_user_tags](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_popular_user_tags) | \u274c      |\n| [get_tags_related](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tags_related)                     | \u274c      |\n| [get_tag](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag)                                       | \u274c      |\n| [put_tag](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_tag)                                       | \u274c      |\n| [get_tag_stream](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_stream)                         | \u274c      |\n| [get_tag_newer](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_newer)                           | \u274c      |\n| [get_tag_users](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_tag_users)                           | \u274c      |\n| [post_tag_user](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_tag_user)                           | \u274c      |\n| [delete_tag_user](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_tag_user)                       | \u274c      |\n\n### Mikroblog\n\n| Method                                                                                                         | Tested? |\n| -------------------------------------------------------------------------------------------------------------- | ------- |\n| [get_entries](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entries)               | \u274c      |\n| [post_entry](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry)                 | \u2714\ufe0f      |\n| [get_entry_by_id](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_by_id)       | \u2714\ufe0f      |\n| [put_entry](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_entry)                   | \u2714\ufe0f      |\n| [delete_entry_by_id](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_by_id) | \u2714\ufe0f      |\n| [get_entry_votes](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_votes)       | \u2714\ufe0f      |\n| [post_entry_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_vote)       | \u26d4      |\n| [delete_entry_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_vote)   | \u26d4      |\n| [get_entries_newer](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entries_newer)   | \u274c      |\n\n### Mikroblog - komentarze\n\n| Method                                                                                                                       | Tested? |\n| ---------------------------------------------------------------------------------------------------------------------------- | ------- |\n| [get_entry_comments](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comments)               | \u274c      |\n| [post_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_comment)               | \u274c      |\n| [get_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comment)                 | \u274c      |\n| [put_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.put_entry_comment)                 | \u274c      |\n| [delete_entry_comment](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_comment)           | \u274c      |\n| [get_entry_comment_votes](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.get_entry_comment_votes)     | \u274c      |\n| [post_entry_comment_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.post_entry_comment_vote)     | \u274c      |\n| [delete_entry_comment_vote](https://kaisermovet.github.io/pywykop3/api.html#pywykop3.api.WykopAPI.delete_entry_comment_vote) | \u274c      |\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Wykop v2 REST API Client",
    "version": "0.5.0",
    "split_keywords": [
        "wykop"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06375a456de29ef473f08bb3dd722424f72f6c87905e43007f9167c5c1753eb5",
                "md5": "930661e807c83da3de9eca89bdfdc5d7",
                "sha256": "b220b438725df550f1a673960be0cd0509722ba9315dfeda7da0c087ea83fcba"
            },
            "downloads": -1,
            "filename": "pywykop3-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "930661e807c83da3de9eca89bdfdc5d7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9704,
            "upload_time": "2023-03-19T22:58:22",
            "upload_time_iso_8601": "2023-03-19T22:58:22.064793Z",
            "url": "https://files.pythonhosted.org/packages/06/37/5a456de29ef473f08bb3dd722424f72f6c87905e43007f9167c5c1753eb5/pywykop3-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7678030805318b7028cacd8283e697b2f967dca48b0931faf84c2e094e461c7",
                "md5": "d729a1348ebc508c302d0a63129fa8d8",
                "sha256": "857dba5c69753faab6937a0b9f915716974f93e2e1d0f0705e9a3a094931dfed"
            },
            "downloads": -1,
            "filename": "pywykop3-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d729a1348ebc508c302d0a63129fa8d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10124,
            "upload_time": "2023-03-19T22:58:23",
            "upload_time_iso_8601": "2023-03-19T22:58:23.909212Z",
            "url": "https://files.pythonhosted.org/packages/f7/67/8030805318b7028cacd8283e697b2f967dca48b0931faf84c2e094e461c7/pywykop3-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-19 22:58:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "KaiserMovet",
    "github_project": "pywykop3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        }
    ],
    "lcname": "pywykop3"
}
Mateusz Rynkiewicz
Elapsed time: 0.08964s