Metadata-Version: 2.4
Name: extractreqs
Version: 0.1.1
Summary: A tool to automatically extract and generate requirements.txt from Python source code by analyzing imports.
Author: hasanaliozkan
Author-email: hasanaliozkan <hasanaliozkan@mu.edu.tr>
Maintainer-email: hasanaliozkan <hasanaliozkan@mu.edu.tr>
License: MIT
Project-URL: bugs, https://github.com/hasanaliozkan-dev/extractreqs/issues
Project-URL: changelog, https://github.com/hasanaliozkan-dev/extractreqs/blob/master/changelog.md
Project-URL: homepage, https://github.com/hasanaliozkan-dev/extractreqs
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: ty; extra == "test"
Requires-Dist: ipdb; extra == "test"
Dynamic: author
Dynamic: license-file

# extractreqs

![PyPI version](https://img.shields.io/pypi/v/extractreqs.svg)
[![License - MIT 3-Clause](https://img.shields.io/pypi/l/sfsgl.svg)](https://github.com/hasanaliozkan-dev/sfsgl/blob/main/LICENSE)
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/extractreqs?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/extractreqs)
![Visitors](https://visitor-badge.laobi.icu/badge?page_id=hasanaliozkan-dev/extractreqs)

extractreqs is a tool to automatically extract and generate requirements.txt from Python source code by analyzing imports.

## How to Use

### Command Line

From your project root, run:

```bash
extractreqs . -o requirements.txt
```

This will analyze your source code and generate a requirements.txt file.

### As a Python Module

You can also use extractreqs in your own scripts:

```python
import extractreqs
reqs = extractreqs.extractreq(src_dir="/path/to/your/source", write=True)
print(reqs)
```

This will return a sorted list of requirements found in the given source directory.

* PyPI package: https://pypi.org/project/extractreqs/
* Free software: MIT License
* Documentation: https://extractreqs.readthedocs.io.

## Features

* TODO

## Credits

This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
