Metadata-Version: 2.1
Name: gitcln
Version: 20.4.4
Summary: CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
Home-page: https://github.com/hadizakialqattan/gitcln
Author: Hadi Zaki Alqattan
Author-email: alqattanhadizaki@gmail.com
License: MIT License
Description: <h1 align="center">Welcome to Gitcln 👋</h1>
        <p>
          <a href="https://github.com/hadizakialqattan/gitcln/actions?query=workflow%3ACI"><img alt="CI" src="https://github.com/hadizakialqattan/gitcln/workflows/CI/badge.svg"/>
          </a>
          <a href="https://github.com/hadizakialqattan/gitcln/actions?query=workflow%3ACD"><img alt="CD" src="https://github.com/hadizakialqattan/gitcln/workflows/CD/badge.svg"/>
          </a>
          <a href="https://www.codacy.com/manual/HadiZakiAlQattan/gitcln?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=hadizakialqattan/gitcln&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/aea96341167f4b5097f6edfa52ae9439"/>
          </a>
          <a href="https://pypi.org/project/gitcln/" target="_blank">  
            <img alt="Version" src="https://img.shields.io/github/release/hadizakialqattan/gitcln.svg" />
          </a>
          <a href="https://pypi.org/project/gitcln/"><img alt="Pyversions" src="https://img.shields.io/pypi/pyversions/gitcln.svg">
          </a>
          <a href="https://docutils.sourceforge.io/rst.html"><img alt="Docstrings: reStructuredText" src="https://img.shields.io/badge/docstrings-reStructuredText-gree.svg">
          </a>
          <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
          </a>
          <a href="https://github.com/hadizakialqattan/sudoku/blob/master/LICENSE" target="_blank">  
            <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg" />
          </a>
        </p>
        
          > CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
        
          > you can create or [download .gitignore](https://github.com/github/gitignore) file and use this tool anywhere.
        
        # Installation ⚓
        
        ```shell 
        $ pip install gitcln
        ```
        
        # Usage 🗝
        
        |Arg|Shortcut|Type|Description|Default|
        |:---:|:---:|:---:|:---:|:---:|
        |--directories|-d|optional|directory(ies) to ignore|[ ]|
        |--files|-f|optional|file(s) to ignore|[ ]|
        ```shell 
        $ gitcln --help
        ```
        ```shell
        usage: gitcln [-h] [-d [DIRECTORIES [DIRECTORIES ...]]] [-f [FILES [FILES ...]]]
        
        CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
        
        optional arguments:
        
          -h, --help            show this help message and exit
        
          -d [DIRECTORIES [DIRECTORIES ...]], --directories [DIRECTORIES [DIRECTORIES ...]]
                                Directory(ies) to ignore. (default: [])
        
          -f [FILES [FILES ...]], --files [FILES [FILES ...]]
                                File(s) to ignore. (default: [])
        ```
        
        ### Examples : 
        
        - Remove all .gitignore file(s)/folder(s) :
            ```shell 
            $ gitcln
            ```
        - Remove all .gitignore file(s)/folder(s) except specific directory(ies) :
            ```shell 
            $ gitcln -d __pycache__
            ```
        - Remove all .gitignore file(s)/folder(s) except specific file(s) :
            ```shell 
            $ gitcln -f bytes.pyc
            ```
        
        # Tests 🧪
        
          > Only integration tests for gitcln module runs on the CI pipeline.
        
        # Roadmap 📈
        
        * Add additional CLI option to skip .gitignore ignores by unique comment.
        * Add .gitcln file to ignore file(s) folder(s) from scanning.
        * Filter .gitignore by section name.
        
        # Copyright ©
        
        👤 **Hadi Zaki Alqattan**
        
        * Github: [@hadizakialqattan](https://github.com/hadizakialqattan)
        * Email: <alqattanhadizaki@gmail.com>
        
        📝 **License**
        
        Copyright © 2020 [Hadi Zaki Alqattan](https://github.com/hadizakialqattan).<br />
        This project is [MIT](https://github.com/hadizakialqattan/sudoku/blob/master/LICENSE) licensed.
        
        ***
        Give a ⭐️ if this project helped you!
        
Keywords: python,cli,tools,cleaner,git-tools
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
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: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Python: >=3
Description-Content-Type: text/markdown
