Metadata-Version: 2.1
Name: markyp-rss
Version: 0.1910.0
Summary: markyp-based RSS 2.0 implementation.
Home-page: https://github.com/volfpeter/markyp-rss
Author: Peter Volf
Author-email: do.volfp@gmail.com
License: MIT
Description: [![Build Status](https://travis-ci.org/volfpeter/markyp-rss.svg?branch=master)](https://travis-ci.org/volfpeter/markyp-rss)
        [![Downloads](https://pepy.tech/badge/markyp-rss)](https://pepy.tech/project/markyp-rss)
        [![Downloads](https://pepy.tech/badge/markyp-rss/month)](https://pepy.tech/project/markyp-rss/month)
        [![Downloads](https://pepy.tech/badge/markyp-rss/week)](https://pepy.tech/project/markyp-rss/week)
        
        # markyp-rss
        
        [markyp](https://github.com/volfpeter/markyp)-based RSS 2.0 implementation.
        
        ## Installation
        
        The project is listed on the Python Package Index, it can be installed simply by executing `pip install markyp-rss`.
        
        ## Getting started
        
        If 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).
        
        Creating 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.
        
        ```Python
        from typing import List, Optional
        
        from markyp_rss.elements import Category, Channel, Image, Item, RSS
        
        def get_items() -> Optional[List[Item]]:
            """Returns the items to be included in the channel."""
            return [
                Item("First", "https://markyp.demo/first"),
                Item("Second", "https://markyp.demo/second"),
                Item("Third", "https://markyp.demo/third")
            ]
        
        rss = RSS(
            Channel(
                "markyp-rss RSS 2.0 Demo Channel",
                "https://markyp.demo/channel.rss",
                "RSS 2.0 example built using markyp-rss.",
                language="en-us",
                image=Image("markyp-rss RSS 2.0 Demo Channel", "https://markyp.demo/channel.jpeg", "https://markyp.demo/channel.rss"),
                ttl=40,
                categories=[Category("Demo"), Category("Example")],
                items=get_items()
            )
        )
        
        print(rss)
        ```
        
        For more details, please have a look at the `markyp_rss.elements` module.
        
        ## Community guidelines
        
        In general, please treat each other with respect and follow the below guidelines to interact with the project:
        
        - _Questions, feedback_: Open an issue with a `[Question] <issue-title>` title.
        - _Bug reports_: Open an issue with a `[Bug] <issue-title>` title, an adequate description of the bug, and a code snippet that reproduces the issue if possible.
        - _Feature requests and ideas_: Open an issue with an `[Enhancement] <issue-title>` title and a clear description of the enhancement proposal.
        
        ## Contribution guidelines
        
        Every form of contribution is welcome, including documentation improvements, tests, bug fixes, and feature implementations.
        
        Please follow these guidelines to contribute to the project:
        
        - 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.
        - `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`.
        - _Small_ fixes can be submitted simply by creating a pull request.
        - Non-trivial changes should have an associated [issue](#community-guidelines) in the issue tracker that commits must reference (typically by adding `#refs <issue-id>` to the end of commit messages).
        - Please write [tests](#testing) for the changes you make (if applicable).
        
        If you have any questions about contributing to the project, please contact the project owner.
        
        As 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.
        
        The 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.
        
        If `pytest` is installed, the test set can be executed using the `pytest test` command from within the project directory.
        
        If `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.
        
        ## License - MIT
        
        The library is open-sourced under the conditions of the MIT [license](https://choosealicense.com/licenses/mit/).
        
Keywords: rss markup generator feed utility
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
