Metadata-Version: 2.4
Name: face-miner
Version: 1.0.0
Summary: Extractor for HuggingFace models
Project-URL: Homepage, https://github.com/F201
Project-URL: Issues, https://github.com/F201/hf-extractor
Author-email: "Jati H. Husen" <jatihusen@telkomuniversity.ac.id>, Adam Rafif Faqih <adamrafif@student.telkomuniversity.ac.id>, "M. Daffa Raygama" <daffraygama@student.telkomuniversity.ac.id>, Yanwar Ardika Cahyani <yanwardika@student.telkomuniversity.ac.id>, Farah <farah@student.telkomuniversity.ac.id>
License: MIT License
        
        Copyright (c) 2025 FaceMiner
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: extractor,huggingface,library
Classifier: Framework :: Flask
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: flask
Requires-Dist: huggingface-hub
Requires-Dist: pandas
Requires-Dist: requests
Description-Content-Type: text/markdown

# Hugging Face Extractor

A web-based tool to extract metadata for models from the Hugging Face Hub.

## Features

* Extract information for a single model or all models.
* Fetches metadata, tags, datasets, CO2 emissions, commits, discussions, and file manifests.
* Multi-threaded extraction for performance.
* Download the extracted data as a ZIP file containing multiple CSVs.
* Ability to resume a full crawl if interrupted.

## Installation

1.  Clone the repository:
    ```bash
    git clone [https://github.com/yourusername/hf-extractor.git](https://github.com/yourusername/hf-extractor.git)
    cd hf-extractor
    ```

2.  Install the required packages and make the project recognizable as a local package:
    ```bash
    pip install -e .
    ```

## Usage

1.  Run the Flask application from the project's root directory:
    ```bash
    python run.py
    ```

2.  Open your web browser and navigate to `http://127.0.0.1:5050`.

3.  Use the web interface to start the extraction process.