{ "info": { "author": "Peter Volf", "author_email": "do.volfp@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Code Generators", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Text Processing :: Markup", "Topic :: Utilities", "Typing :: Typed" ], "description": "[![Build Status](https://travis-ci.org/volfpeter/markyp-rss.svg?branch=master)](https://travis-ci.org/volfpeter/markyp-rss)\n[![Downloads](https://pepy.tech/badge/markyp-rss)](https://pepy.tech/project/markyp-rss)\n[![Downloads](https://pepy.tech/badge/markyp-rss/month)](https://pepy.tech/project/markyp-rss/month)\n[![Downloads](https://pepy.tech/badge/markyp-rss/week)](https://pepy.tech/project/markyp-rss/week)\n\n# markyp-rss\n\n[markyp](https://github.com/volfpeter/markyp)-based RSS 2.0 implementation.\n\n## Installation\n\nThe project is listed on the Python Package Index, it can be installed simply by executing `pip install markyp-rss`.\n\n## Getting started\n\nIf you are not familiar with the basic concepts of `markyp`, please start by having a look at its documentation [here](https://github.com/volfpeter/markyp).\n\nCreating an RSS 2.0 feed using `markyp-rss` is as easy as instantiating the required RSS elements and converting the `RSS` object to string when the feed is ready.\n\n```Python\nfrom typing import List, Optional\n\nfrom markyp_rss.elements import Category, Channel, Image, Item, RSS\n\ndef get_items() -> Optional[List[Item]]:\n \"\"\"Returns the items to be included in the channel.\"\"\"\n return [\n Item(\"First\", \"https://markyp.demo/first\"),\n Item(\"Second\", \"https://markyp.demo/second\"),\n Item(\"Third\", \"https://markyp.demo/third\")\n ]\n\nrss = RSS(\n Channel(\n \"markyp-rss RSS 2.0 Demo Channel\",\n \"https://markyp.demo/channel.rss\",\n \"RSS 2.0 example built using markyp-rss.\",\n language=\"en-us\",\n image=Image(\"markyp-rss RSS 2.0 Demo Channel\", \"https://markyp.demo/channel.jpeg\", \"https://markyp.demo/channel.rss\"),\n ttl=40,\n categories=[Category(\"Demo\"), Category(\"Example\")],\n items=get_items()\n )\n)\n\nprint(rss)\n```\n\nFor more details, please have a look at the `markyp_rss.elements` module.\n\n## Community guidelines\n\nIn general, please treat each other with respect and follow the below guidelines to interact with the project:\n\n- _Questions, feedback_: Open an issue with a `[Question] ` title.\n- _Bug reports_: Open an issue with a `[Bug] ` title, an adequate description of the bug, and a code snippet that reproduces the issue if possible.\n- _Feature requests and ideas_: Open an issue with an `[Enhancement] ` title and a clear description of the enhancement proposal.\n\n## Contribution guidelines\n\nEvery form of contribution is welcome, including documentation improvements, tests, bug fixes, and feature implementations.\n\nPlease follow these guidelines to contribute to the project:\n\n- Make sure your changes match the documentation and coding style of the project, including [PEP 484](https://www.python.org/dev/peps/pep-0484/) type annotations.\n- `mypy` is used to type-check the codebase, submitted code should not produce typing errors. See [this page](http://mypy-lang.org/) for more information on `mypy`.\n- _Small_ fixes can be submitted simply by creating a pull request.\n- Non-trivial changes should have an associated [issue](#community-guidelines) in the issue tracker that commits must reference (typically by adding `#refs ` to the end of commit messages).\n- Please write [tests](#testing) for the changes you make (if applicable).\n\nIf you have any questions about contributing to the project, please contact the project owner.\n\nAs mentioned in the [contribution guidelines](#contribution-guidelines), the project is type-checked using `mypy`, so first of all, the project must pass `mypy`'s static code analysis.\n\nThe project is tested using `pytest`. The chosen test layout is that tests are outside the application code, see [this page](https://docs.pytest.org/en/latest/goodpractices.html#tests-outside-application-code) for details on what it means in practice.\n\nIf `pytest` is installed, the test set can be executed using the `pytest test` command from within the project directory.\n\nIf `pytest-cov` is also installed, a test coverage report can be generated by executing `pytest test --cov markyp_rss` from the root directory of the project.\n\n## License - MIT\n\nThe library is open-sourced under the conditions of the MIT [license](https://choosealicense.com/licenses/mit/).\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/volfpeter/markyp-rss", "keywords": "rss markup generator feed utility", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "markyp-rss", "package_url": "https://pypi.org/project/markyp-rss/", "platform": "", "project_url": "https://pypi.org/project/markyp-rss/", "project_urls": { "Homepage": "https://github.com/volfpeter/markyp-rss" }, "release_url": "https://pypi.org/project/markyp-rss/0.1910.0/", "requires_dist": [ "markyp (>=0.1910)" ], "requires_python": ">=3.6", "summary": "markyp-based RSS 2.0 implementation.", "version": "0.1910.0" }, "last_serial": 5972534, "releases": { "0.1904.0": [ { "comment_text": "", "digests": { "md5": "90735db94a95da5abd687789dc5c8483", "sha256": "192864681b995deeef1d4962b6ddf821e762943d7e4361551ac1c04582159a73" }, "downloads": -1, "filename": "markyp_rss-0.1904.0-py3-none-any.whl", "has_sig": false, "md5_digest": "90735db94a95da5abd687789dc5c8483", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7891, "upload_time": "2019-04-15T20:35:49", "url": "https://files.pythonhosted.org/packages/15/e1/87ee7616760305627440d3c503b243241c591a4e21ee0c2cefe47424ddc4/markyp_rss-0.1904.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "58ee5d61885ec72ea0a64ee51de80b82", "sha256": "61c65ea5fb28415ab8375e435f68e2c241ae2b1775e31aaa29379d48fa730c30" }, "downloads": -1, "filename": "markyp-rss-0.1904.0.tar.gz", "has_sig": false, "md5_digest": "58ee5d61885ec72ea0a64ee51de80b82", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 9400, "upload_time": "2019-04-15T20:35:52", "url": "https://files.pythonhosted.org/packages/41/e2/4e67ef1984a780d90dcab564c9245d5ac061bb7ac6c30c1eee2824515358/markyp-rss-0.1904.0.tar.gz" } ], "0.1905.0": [ { "comment_text": "", "digests": { "md5": "13c8ccf65df84f7ad11ec4d8dc2084e8", "sha256": "1c407d147ce2d4fedac34f3c87b0d58f1265ffe56bac1e3cd0ce5905d4c99f65" }, "downloads": -1, "filename": "markyp_rss-0.1905.0-py3-none-any.whl", "has_sig": false, "md5_digest": "13c8ccf65df84f7ad11ec4d8dc2084e8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7986, "upload_time": "2019-05-06T21:13:59", "url": "https://files.pythonhosted.org/packages/ed/f5/a6030c10e716964b7e8529443e0d46dc60db277b47a491eb03bd48aefd8d/markyp_rss-0.1905.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "edc6b89eae347670fbb629dded40d816", "sha256": "085e2129301b1524e3e0838a20a0185bdbd0af85fb63afb7252e0aed11d99fe7" }, "downloads": -1, "filename": "markyp-rss-0.1905.0.tar.gz", "has_sig": false, "md5_digest": "edc6b89eae347670fbb629dded40d816", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 9507, "upload_time": "2019-05-06T21:14:01", "url": "https://files.pythonhosted.org/packages/6b/49/1c58f17822d8cb931bde4501502970bc4b1b81836cb8e9d13d19b789d381/markyp-rss-0.1905.0.tar.gz" } ], "0.1910.0": [ { "comment_text": "", "digests": { "md5": "1877fda7f9c2008e31e197ea33835a94", "sha256": "a45b11273ff35a3f966d4bfb415a6bb23a0bcae94df21a7a3904cc54d6e8bd50" }, "downloads": -1, "filename": "markyp_rss-0.1910.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1877fda7f9c2008e31e197ea33835a94", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8074, "upload_time": "2019-10-14T17:48:41", "url": "https://files.pythonhosted.org/packages/05/2c/cce694ea78b01e548b95651948244bbc3cffa8185f1af927da83ced396f7/markyp_rss-0.1910.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "63a9ca52294b77172e5958c330263aaf", "sha256": "18940a8bc804fce32b2c7083181e05c7ac03a47891c41bf8b91bec0c0566dc5f" }, "downloads": -1, "filename": "markyp-rss-0.1910.0.tar.gz", "has_sig": false, "md5_digest": "63a9ca52294b77172e5958c330263aaf", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 9618, "upload_time": "2019-10-14T17:48:43", "url": "https://files.pythonhosted.org/packages/30/0e/e6413b405d67abf845a91d4f09d7d3fcf0d75adb8f38c7336caec6a3260c/markyp-rss-0.1910.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1877fda7f9c2008e31e197ea33835a94", "sha256": "a45b11273ff35a3f966d4bfb415a6bb23a0bcae94df21a7a3904cc54d6e8bd50" }, "downloads": -1, "filename": "markyp_rss-0.1910.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1877fda7f9c2008e31e197ea33835a94", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8074, "upload_time": "2019-10-14T17:48:41", "url": "https://files.pythonhosted.org/packages/05/2c/cce694ea78b01e548b95651948244bbc3cffa8185f1af927da83ced396f7/markyp_rss-0.1910.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "63a9ca52294b77172e5958c330263aaf", "sha256": "18940a8bc804fce32b2c7083181e05c7ac03a47891c41bf8b91bec0c0566dc5f" }, "downloads": -1, "filename": "markyp-rss-0.1910.0.tar.gz", "has_sig": false, "md5_digest": "63a9ca52294b77172e5958c330263aaf", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 9618, "upload_time": "2019-10-14T17:48:43", "url": "https://files.pythonhosted.org/packages/30/0e/e6413b405d67abf845a91d4f09d7d3fcf0d75adb8f38c7336caec6a3260c/markyp-rss-0.1910.0.tar.gz" } ] }