Skip to main content

CLI tool for analyzing and curating awesome lists focused on sustainable and open source technologies

Project description

KHC CLI

KHC CLI

PyPI version PyPI Downloads [GitHub Stars] License: MIT Python Version Documentation Status

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

Installation

pip install khc-cli

Version

khc-cli --version

Help

khc-cli --help

Commandes

GitHub API check Status

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

khc-cli analyze <url_github>

More Options

khc-cli analyze --help

Documentation

For more information, please refer to the Read The Docs.

Development

To contribute to the project:

# 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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

khc_cli-1.17.0.tar.gz (164.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

khc_cli-1.17.0-py3-none-any.whl (165.4 kB view details)

Uploaded Python 3

File details

Details for the file khc_cli-1.17.0.tar.gz.

File metadata

  • Download URL: khc_cli-1.17.0.tar.gz
  • Upload date:
  • Size: 164.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for khc_cli-1.17.0.tar.gz
Algorithm Hash digest
SHA256 96760693ab812d9d7e14c4be04b02a1d981af291e49a29e11496a31224a00376
MD5 edd97dc636d14a57216a4729f11e6b3a
BLAKE2b-256 12f2d5e4bc34c990025246101d41019e090740f399c4a95a4c2b40cd093aaf96

See more details on using hashes here.

File details

Details for the file khc_cli-1.17.0-py3-none-any.whl.

File metadata

  • Download URL: khc_cli-1.17.0-py3-none-any.whl
  • Upload date:
  • Size: 165.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for khc_cli-1.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6aa1207e652ba95542eca69c6ab733589acfcbd8b94ef6284dc65cb98c9995d3
MD5 3470adf4a6380533fe7ca61b2d64187d
BLAKE2b-256 23b3d374ab5964f6d0828b4b4af142c830f55fa09cadec4ece7bcb6b2c65e997

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page