Welcome to profile-readme’s documentation!

profile-readme is a CLI tool for generating a GitHub profile README.

It lets you use all features provide by Jinja2 to help you customizes your GitHub profile README and it provides data from the GitHub API to your template.

User Guides

This part of the documentation guides you through all of the library’s usage patterns.

• Installation
  • Prerequisites
  • Installing the most recent version
  • Installing the development version
• Quickstart
• Advanced Usage
  • Using Custom Build Scripts
  • Loading Data
  • Filters

API Documentation

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• CLI Documentation
  • Invocation
  • Getting Help
  • CLI
• API Documentation
  • Basic API Usage
  • API
• Changelog
  • 0.1.2
  • 0.1.1
  • 0.1.0
• License
  • License Text

Useful Links

• Source Code
• PyPi Releases
• Bug Tracker

Indices and Tables

• Index

• Module Index

• Search Page