Metadata-Version: 2.1
Name: hcli_hleg
Version: 0.1.0
Summary: HCLI hleg is a pypi wrapper that contains an HCLI sample application (hleg); hleg is a legislature bill aggregation service that helps facilitate rapid action by providing a useful list of bill hearings on a timeline to facilitate testifying (e.g. online testimony).
Home-page: https://github.com/cometaj2/hcli_hleg
Author: Jeff Michaud
Author-email: cometaj2@comcast.net
License: MIT
Keywords: cli client server connector hypermedia rest generic development
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

|pypi|_ |build status|_ |pyver|_

HCLI hc
=======

HCLI hleg is a pypi wrapper that contains an HCLI sample application (hleg); hleg is a legislature bill aggregation service that helps facilitate rapid action by providing a useful list of bill hearings on a timeline to facilitate testifying (e.g. online testimony).

----

HCLI hleg wraps hleg (an HCLI) and is intended to be used with an HCLI Client [1] as presented via an HCLI Connector [2].

You can find out more about HCLI on hcli.io [3]

[1] https://github.com/cometaj2/huckle

[2] https://github.com/cometaj2/hcli_core

[3] http://hcli.io

Installation
------------

HCLI hleg requires a supported version of Python and pip.

You'll need an HCLI Connector to run hc. For example, you can use HCLI Core (https://github.com/cometaj2/hcli_core), a WSGI server such as Green Unicorn (https://gunicorn.org/), and an HCLI Client like Huckle (https://github.com/cometaj2/huckle).


.. code-block:: console

    pip install hcli-hleg
    pip install hcli-core
    pip install huckle
    pip install gunicorn
    gunicorn --workers=1 --threads=1 -b 127.0.0.1:8000 --chdir `hcli_core path` "hcli_core:connector(\"`hcli_hleg path`\")"

Usage
-----

Open a different shell window.

Setup the huckle env eval in your .bash_profile (or other bash configuration) to avoid having to execute eval everytime you want to invoke HCLIs by name (e.g. hleg).

Note that no CLI is actually installed by Huckle. Huckle reads the HCLI semantics exposed by the API via HCLI Connector and ends up behaving *like* the CLI it targets.


.. code-block:: console

    huckle cli install http://127.0.0.1:8000
    eval $(huckle env)
    hleg help

Versioning
----------
    
This project makes use of semantic versioning (http://semver.org) and may make use of the "devx",
"prealphax", "alphax" "betax", and "rcx" extensions where x is a number (e.g. 0.3.0-prealpha1)
on github.

Supports
--------

- Washington State Legislature bills aggregation

To Do
-----

- Legislature bills aggregation for other U.S. States

Bugs
----

.. |build status| image:: https://circleci.com/gh/cometaj2/hcli_hleg.svg?style=shield
.. _build status: https://circleci.com/gh/cometaj2/hcli_hleg
.. |pypi| image:: https://img.shields.io/pypi/v/hcli-hleg?label=hcli-hleg
.. _pypi: https://pypi.org/project/hcli-hleg
.. |pyver| image:: https://img.shields.io/pypi/pyversions/hcli-hleg.svg
.. _pyver: https://pypi.org/project/hcli-hleg
