/git-ascii

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


git-ascii

Creating "ASCII Art" using the contributions heatmap

Read Docs · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This project uses python's datetime to calculate the date that each commit must be sent. It uses os to send git commands to the terminal and exploits git's ability to create commits to the past (and future) to create art.

Sample inputs are stored in the /inputs folder. Each non-whitespace character represents a filled-in block on the GitHub contributions page. Only the first 7 lines and 53 characters of each line are parsed.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • python
  • git

Installation

  1. Create a copy of this repository
Use this template
  1. Clone the repo
    git clone https://github.com/[YOUR-USERNAME]/[YOUR-REPO-NAME].git

Usage

Navigate to the local repo and run the following line in the terminal

python3 main.py -i inputs/hello.txt

To remove the commits, delete the repository.

For more examples, please refer to the Documentation

Roadmap

  • Improve ease of use (remove need to copy files from one repo to another)
  • WIP Make use of the contribution page's full color palette
  • Decrease runtime (create git tree manually as opposed to using git commits)
  • Create more sample inputs

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tariq - tariapper@outlook.com

Project Link: https://github.com/tariapper/git-ascii

Acknowledgements