Metadata-Version: 2.1
Name: sort-requirements-file
Version: 0.0.1
Summary: A package used to sort you requirements file.
Home-page: https://github.com/HigherOrderLogic/sort-requirements-file
Author: HigherOrderLogic
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: docs
License-File: LICENSE

<div align="center">

<h1>
  sort-requirements-file
</h1>

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

<br>
    
A CLI application used to sort your requirements file (`requirements.txt`, `poetry.toml`, ...), inspired by <a href="https://www.npmjs.com/package/sort-package-json">sort-package-json</a>.<br>

<br>

</div>

---

<br>

<details>
<summary>
  Table of contents
</summary>
  <br>
  <li> 
    <a href="#install">
      Install
    </a> 
  </li>
  <br>
  <li> 
    <a href="#usage">
      Usage
    </a> 
  </li>
</details>

<br>

## Install
You can install this package by cloning this repository, then run the [`setup.py`](/setup.py) file, or by using `pip` (the recommened way).
- Install using pip.
  Open the terminal, then run this command.
  ```cmd
  pip install git+https://github.com/HigherOrderLogic/sort-requirements-file
  ```
- Install using `git`.
  ```cmd
  # Clone the repository
  git clone https://github.com/HigherOrderLogic/sort-requirements-file.git
  cd sort-requirements-file
  # Install the package
  python setup.py install
  ```

## Usage
Open the terminal at where you requirements file is, the run `python -m sort_requirements_file`, and boom, your requirements file is sorted!
<br>

For more information on how to use the file, please see the documents.
