Metadata-Version: 2.1
Name: lmodule
Version: 0.4.0
Summary: Lmod Module API
Home-page: https://github.com/buildtesters/lmodule
Author: Shahzeb Siddiqui
Author-email: shahzebmsiddiqui@gmail.com
License: MIT
Project-URL: Source Code, https://github.com/buildtesters/lmodule
Project-URL: Documentation, https://lmodule.readthedocs.io/
Project-URL: Bug Report, https://github.com/buildtesters/lmodule/issues
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.6, <4

|license| |docs| |codecov| |pypi| |python|

.. |docs| image:: https://readthedocs.org/projects/lmodule/badge/?version=latest
    :target: https://readthedocs.org/projects/lmodule/builds/
    :alt: Documentation Status
.. |license| image:: https://img.shields.io/github/license/buildtesters/lmodule.svg
    :target: https://github.com/buildtesters/lmodule/blob/master/LICENSE
.. |codecov| image:: https://codecov.io/gh/buildtesters/lmodule/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/buildtesters/lmodule
.. |pypi| image:: https://img.shields.io/pypi/v/lmodule.svg
    :target: https://pypi.org/project/lmodule/
.. |python| image:: https://img.shields.io/pypi/pyversions/lmodule.svg
    :target: https://pypi.org/project/lmodule/


Lmodule (Lmod Module)
---------------------

Lmodule is a Python 3 API for `Lmod <https://lmod.readthedocs.io/>`_ module system. Lmodule can assist HPC facilities in testing their
software stack via ``module load`` testing. The API can be used by developers and system-administrators for interacting with module system.
Developers can utilize the Lmodule API for interacting  with module system in their python code, while System Administrators can leverage 
the Lmodule API for testing their Software Stack.


Author
-------

lmodule was created by `Shahzeb Siddiqui <http://github.com/shahzebsiddiqui/>`_.

Contributing Back
------------------

We encourage community feedback and participation to help improve the lmodule API. To get started you can do the following:

- Join the slack community

- Test the API and provide feedback in the form of `Issue <https://github.com/buildtesters/lmodule/issues>`_ or `Pull Request <https://github.com/buildtesters/lmodule/pulls>`_.


Slack
------

Click the `Join Slack Channel <https://communityinviter.com/apps/hpcbuildtest/buildtest-slack-invitation>`_ to join the community.
If you already have an account then access the Slack Channel `here  <https://hpcbuildtest.slack.com>`_

LICENSE
---------

lmodule is released under the MIT license. See the `LICENSE <https://github.com/buildtesters/lmodule/blob/master/LICENSE>`_
file for more details.

Talks
------

- **Automate Module Testing with Lmodule** at `EasyBuild User Meeting <https://easybuild.io/eum/>`_ - `Slides <https://easybuild.io/eum21/023_eum21_Lmodule.pdf>`_,  `Video <https://www.youtube.com/watch?v=RyUhPSzIrqQ&list=PLhnGtSmEGEQh0pCtmkFQsDzeoo6tbYnyZ&index=30>`_



