Metadata-Version: 2.4
Name: khc-cli
Version: 1.17.0
Summary: CLI tool for analyzing and curating awesome lists focused on sustainable and open source technologies
Project-URL: Homepage, https://github.com/aguennoune/khc-cli
Project-URL: Bug Tracker, https://github.com/aguennoune/khc-cli/issues
Project-URL: Documentation, https://khc-cli.readthedocs.io/
Author-email: Abderrahim Guennoune <aguennoune@outlook.com>
License: MIT License
        
        Copyright (c) 2025 Krypto Hashers Community
        
        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: analysis,awesome-list,cli,curation,github,open-source,sustainability,technology
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: <4.0,>=3.10
Requires-Dist: beautifulsoup4>=4.12.2
Requires-Dist: markdown>=3.8
Requires-Dist: pygithub>=2.1.1
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: requests>=2.31.0
Requires-Dist: rich>=13.6.0
Requires-Dist: termcolor>=2.3.0
Requires-Dist: twine>=6.1.0
Requires-Dist: typer>=0.16.0
Requires-Dist: typing-extensions>=4.8.0
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == 'dev'
Requires-Dist: isort>=5.12.0; extra == 'dev'
Requires-Dist: mypy>=1.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: ruff>=0.0.270; extra == 'dev'
Requires-Dist: sphinx-click>=4.4.0; extra == 'dev'
Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == 'dev'
Requires-Dist: sphinx>=7.0.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-click>=4.4.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == 'docs'
Requires-Dist: sphinx>=7.0.0; extra == 'docs'
Description-Content-Type: text/markdown

## KHC CLI

# KHC CLI

[![PyPI version](https://img.shields.io/pypi/v/khc-cli.svg)](https://pypi.org/project/khc-cli/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/khc-cli.svg)](https://pypi.org/project/khc-cli/)
[![GitHub Stars](https://img.shields.io/github/stars/Krypto-Hashers-Community/khc-cli.svg?style=social)]
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Version](https://img.shields.io/pypi/pyversions/khc-cli.svg)](https://pypi.org/project/khc-cli/)
[![Documentation Status](https://readthedocs.org/projects/khc-cli/badge/?version=latest)](https://khc-cli.readthedocs.io/en/latest/?badge=latest)

Command-line tool for analyzing and curating Awesome lists, specialized for sustainable and open source technologies.

## Installation

```bash
pip install khc-cli
```

## Version

```bash
khc-cli --version
```
## Help

```bash
khc-cli --help
```
## Commandes

### GitHub API check Status

```bash
khc-cli status
```

## Templates

The `khc-cli` uses a curated template structure for analyzing and organizing Awesome lists. 
This template focuses on sustainable technologies categories and helps structure the analysis results.

For developers: The template file is included as a resource in the package and is used by the 
`analyze` and `curate` commands.

### Awesome List Analysis

```bash
khc-cli analyze <url_github>
```

### More Options

```bash
khc-cli analyze --help
```

## Documentation
For more information, please refer to the [Read The Docs](https://khc-cli.readthedocs.io/en/latest/).

## Development

To contribute to the project:

```bash
# Cloner le dépôt
git clone https://github.com/Krypto-Hashers-Community/khc-cli.git
cd khc-cli

# Créer un environnement virtuel
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# ou
.venv\Scripts\activate  # Windows

# Installer les dépendances de développement
pip install -e ".[dev]"
```

## Contributing
We welcome contributions to KHC CLI! If you have suggestions for improvements or new features, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository.
3. Create a new branch for your feature or bug fix.
4. Make your changes and commit them.
5. Push your changes to your forked repository.
6. Create a pull request to the main repository.
7. Ensure your code passes all tests and adheres to the project's coding standards.
8. Wait for review and feedback from the maintainers.
9. Address any feedback and make necessary changes.
10. Once approved, your changes will be merged into the main branch.


## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

KHC CLI is a command-line interface tool designed to facilitate the analysis and curation of Awesome lists, with a particular focus on open sustainable technology.

## References to the Open Source Community

Thanks to the Open Source Community that is involved in gathering projects that preserve natural ecosystems through open technology, methods, data, intelligence, knowledge or tools.
