https://github.com/thanaraklee/head-require

head-require is a library that aims to simplify the creation of requirements.txt files. head-require generates requirements.txt based on the packages used in your project.
https://github.com/thanaraklee/head-require

library package-manager pip python3

Last synced: 14 days ago
JSON representation

head-require is a library that aims to simplify the creation of requirements.txt files. head-require generates requirements.txt based on the packages used in your project.

• Host: GitHub
• URL: https://github.com/thanaraklee/head-require
• Owner: Thanaraklee
• License: mit
• Created: 2024-03-30T20:00:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-21T09:27:47.000Z (7 months ago)
• Last Synced: 2025-03-28T23:34:18.272Z (about 1 month ago)
• Topics: library, package-manager, pip, python3
• Language: Python
• Homepage: https://pypi.org/project/head-require/
• Size: 132 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        










| Badge | Link |

|-------|------|

| ![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg) | [License](https://github.com/Thanaraklee/Head-Require/blob/main/LICENSE) |

| ![Upload Python Package](https://github.com/Thanaraklee/Head-Require/actions/workflows/python-publish.yml/badge.svg?event=release) | [Python Publish](https://github.com/Thanaraklee/Head-Require/actions/workflows/python-publish.yml) |

| ![PyPI Downloads](https://img.shields.io/pypi/dm/head-require.svg?label=PyPI%20downloads) | [PyPI Stats](https://pypistats.org/packages/head-require) |

| ![PyPI Latest Release](https://img.shields.io/pypi/v/head-require.svg) | [PyPI Latest Release](https://pypi.org/project/head-require/) |

# Head-Require

Head-Require is a Python library designed to simplify the process of generating `requirements.txt` files based on the imported packages in Python files within your project.

## How to Use

### Installation

To install Head-Require, you can use pip:

```bash

pip install head-require

```

### Usage

Once installed, you can use the `head-require` command in the current directory of your project. Here are some common usage examples:

To generate the `requirements.txt` file based on the imported packages in your Python files, simply run:

```bash

head-require

```

#### Help

For a list of available options and their descriptions, you can use the help option:

```bash

head-require -h

```

### Additional Notes

- Make sure to run the `head-require` command in the root directory of your Python project.

- Head-Require analyzes Python files (`*.py` and `*.ipynb`) to extract imported packages and their versions.

# Workflow







❗**Important:**

This command must be executed within the `activated environment`. If it's not activated, it will work under the machine's environment.

Thank you for using Head-Require! 😊