Metadata-Version: 2.1
Name: environments-utils
Version: 1.0.3
Summary: Utilities to identify which environments is your python script running within.
Home-page: https://github.com/LucaCappelletti94/environments_utils
Author: Luca Cappelletti
Author-email: cappelletti.luca94@gmail.com
License: MIT
Description: environments_utils
        =========================================================================================
        |travis| |sonar_quality| |sonar_maintainability| |codacy| |code_climate_maintainability| |pip| |downloads|
        
        Utilities to identify which environments is your python script running within.
        
        How do I install this package?
        ----------------------------------------------
        As usual, just download it using pip:
        
        .. code:: shell
        
            pip install environments_utils
        
        Tests Coverage
        ----------------------------------------------
        Since some software handling coverages sometime get slightly different results, here's three of them:
        
        |coveralls| |sonar_coverage| |code_climate_coverage|
        
        is_tmux
        -----------------------------------
        Return a boolean representing if script is running within a TMUX-like terminal.
        
        .. code:: python
        
            from environments_utils import is_tmux
        
            if not is_tmux():
                print("This script is long running, consider starting it within a TMUX-like terminal.")
        
        is_notebook
        -----------------------------------
        Return a boolean representing if script is running within a jupyter notebook.
        
        .. code:: python
        
            from environments_utils import is_notebook
            from tqdm import tqdm_notebook, tqdm as tqdm_cli
        
            tqdm = tqdm_notebook if is_notebook() else tqdm_cli
        
        Operative system identifiers
        -----------------------------------
        Utilities to identify the operative system running the app.
        
        .. code:: python
        
            from environments_utils import is_macos, is_windows, is_linux
        
            if is_macos():
                print("The OS is macOS")
        
            if is_windows():
                print("The OS is Windows")
        
            if is_linux():
                print("The OS is Linux")
        
        
        .. |travis| image:: https://travis-ci.org/LucaCappelletti94/environments_utils.png
           :target: https://travis-ci.org/LucaCappelletti94/environments_utils
           :alt: Travis CI build
        
        .. |sonar_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_environments_utils&metric=alert_status
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_environments_utils
            :alt: SonarCloud Quality
        
        .. |sonar_maintainability| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_environments_utils&metric=sqale_rating
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_environments_utils
            :alt: SonarCloud Maintainability
        
        .. |sonar_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_environments_utils&metric=coverage
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_environments_utils
            :alt: SonarCloud Coverage
        
        .. |coveralls| image:: https://coveralls.io/repos/github/LucaCappelletti94/environments_utils/badge.svg?branch=master
            :target: https://coveralls.io/github/LucaCappelletti94/environments_utils?branch=master
            :alt: Coveralls Coverage
        
        .. |pip| image:: https://badge.fury.io/py/environments-utils.svg
            :target: https://badge.fury.io/py/environments-utils
            :alt: Pypi project
        
        .. |downloads| image:: https://pepy.tech/badge/environments-utils
            :target: https://pepy.tech/badge/environments-utils
            :alt: Pypi total project downloads 
        
        .. |codacy|  image:: https://api.codacy.com/project/badge/Grade/a1fb39855f23448e8abd01cbf72c44f5
            :target: https://www.codacy.com/app/LucaCappelletti94/environments_utils?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=LucaCappelletti94/environments_utils&amp;utm_campaign=Badge_Grade
            :alt: Codacy Maintainability
        
        .. |code_climate_maintainability| image:: https://api.codeclimate.com/v1/badges/38f586ee270447a1d22a/maintainability
            :target: https://codeclimate.com/github/LucaCappelletti94/environments_utils/maintainability
            :alt: Maintainability
        
        .. |code_climate_coverage| image:: https://api.codeclimate.com/v1/badges/38f586ee270447a1d22a/test_coverage
            :target: https://codeclimate.com/github/LucaCappelletti94/environments_utils/test_coverage
            :alt: Code Climate Coverate
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Provides-Extra: test
