Metadata-Version: 2.1
Name: profile-readme
Version: 0.1.0
Summary: A CLI tool for generating a GitHub profile README.
Home-page: https://github.com/Robert-96/profile-readme
Author: Robert-96
Author-email: dezmereanrobert@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/Robert-96/profile-readme/issues
Project-URL: Documentation, https://github.com/Robert-96/profile-readme/blob/master/README.md
Project-URL: Source, https://github.com/Robert-96/profile-readme
Description: # profile-readme
        
        [![Build Status](https://travis-ci.org/Robert-96/profile-readme.svg?branch=master)](https://travis-ci.org/Robert-96/profile-readme)
        [![Documentation Status](https://readthedocs.org/projects/profile-readme/badge/?version=latest)](https://profile-readme.readthedocs.io/en/latest/?badge=latest)
        
        A CLI tool for generating a GitHub profile README using the [Jinja2](https://jinja.palletsprojects.com/) template engine.
        
        It lets you use all features provide by [Jinja2](https://jinja.palletsprojects.com/) to help you customizes your GitHub profile README and it provides data from the GitHub API to your template.
        
        ## Installation
        
        Use the following command to install `profile-readme`:
        
        ```
        $ python3 -m pip install profile-readme
        ```
        
        ### Living on the edge
        
        If you want to work with the latest code before it’s released, install or update the code from the `master` branch:
        
        ```
        $ python3 -m pip install -U git+https://github.com/Robert-96/profile-readme.git
        ```
        
        ## Quickstart
        
        Use the `init` command to generate a new project with an example template:
        
        ```
        $ profile-readme init
        ```
        
        Use the `render` command to update your `README.md` file:
        
        ```
        $ profile-readme render
        ```
        
        ## Advanced Usage
        
        ### Using Custom Build Scripts
        
        The command line shortcut is convenient, but sometimes your project needs something different than the defaults. To change them, you can use a build script.
        
        A minimal build script looks something like this:
        
        ```python
        from profile_readme import get_github_context, ProfileGenerator
        
        
        context = {}
        
        # If you don't need the GitHub data you can remove the next line
        context.update(**get_github_context('octocat'))
        
        
        if __name__ == "__main__":
            ProfileGenerator.render(
                template_path="README-TEMPLATE.md",
                output_path="README.md",
                context=context
            )
        
        ```
        
        Finally, just save the script as `build.py` (or something similar) and run it with your Python interpreter.
        
        ```
        $ python build.py
        ```
        
        > Note: Don't forgot to also update `.github/workflows/readme.yml`.
        > Replace `python3 -m profile_readme render` with `python3 build.py`.
        
        ### Loading Data
        
        The simplest way to supply data to the template is to pass `ProfileGenerator.render` a mapping from variable names to their values (a “context”) as the `context` keyword argument.
        
        ```python
        from profile_readme import get_github_context, ProfileGenerator
        
        
        context = {
            greeting='Hello, world!'
        }
        
        # If you don't need the GitHub data you can remove the next line
        context.update(**get_github_context('octocat'))
        
        
        if __name__ == "__main__":
            ProfileGenerator.render(
                template_path="README-TEMPLATE.md",
                output_path="README.md",
                context=context
            )
        
        ```
        
        Anything added to this dictionary will be available in the template:
        
        ```md
        # Title
        
        {{ greeting }}
        ```
        
        ### Filters
        
        Variables can be modified by [filters](https://jinja.palletsprojects.com/en/2.11.x/templates/#filters). All the standard Jinja2 filters are supported (you can found the full list [here](https://jinja.palletsprojects.com/en/2.11.x/templates/#builtin-filters)).  To add your own filters, simply pass filters as an argument to `ProfileGenerator`.
        
        ```python
        from profile_readme import get_github_context, ProfileGenerator
        
        
        context = get_github_context('octocat')
        filters = {
            'hello': lambda x: 'Hello, {}!',
        }
        
        
        if __name__ == "__main__":
            ProfileGenerator.render(
                template_path="README-TEMPLATE.md",
                output_path="README.md",
                context=context,
                filters=filters
            )
        
        ```
        
        Then you can use them in your template as you would expect:
        
        ```md
        {{ 'World'|hello }}
        ```
        
        ## License
        
        This project is licensed under the [MIT License](LICENSE).
Keywords: profile-readme,github,profile,readme
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
