Skip to main content

Python support functions package

Project description

skylynx

Status

Build Status

Python support functions module

Only Python 3


Version 0.0.4

skylynx

import skylynx
print('skylynx', skylynx.__version__)

>> skylynx 0.0.2

skylynx.utils

JSON

Write
import skylynx.utils as su

data_dict = dict(
    a=123,
    b='skylynx'
)
su.json_write('example.json', data_dict)
{
  "a": 123,
  "b": "skylynx"
}
Read
data = su.json_read('example.json')
print(data)

>> {'a': 123, 'b': 'skylynx'}

YAML

Write
su.yaml_write('example.yaml', data_dict)
a: 123
b: skylynx
Read
data = su.yaml_read('example.yaml')
print(data)

>> {'a': 123, 'b': 'skylynx'}

Pretty Print

data_dict = dict(
    a='This print a python dict object in a human readable form.',
    b=456,
    c=dict(
        d=123,
        e='skylynx'
    ),
    f = ['abc', 123]
)
su.pprint(data_dict, '> Header <')
======================== > Header < ========================
a: This print a python dict object in a human readable form.
b: 456
c:
  d: 123
  e: skylynx
f: ['abc', 123]
------------------------------------------------------------

Make Directories

path = 'path/to/the/folder/'
su.makedirs(path)
print(os.path.exists(path))

>> True

Simple command line arguments

Add the following code to example.py

from skylynx.utils import cli_args

if __name__ == "__main__":

  cli_params = dict(task=0,
                    length=10
                    )

  args = cli_args(cli_params)
  task = args['task']
  length = args['length']

How to use

python example.py -h
usage: test.py [-h] [-a A] [-b B]

*** Simple cli args - by Skylynx ***

optional arguments:
  -h, --help  show this help message and exit
  -a A        task (default: 0)
  -b B        length (default: 10)
python example.py -a <task value> -b <length value>

clog

Normal use

from skylynx.utils import clog

clog('Hello')

alt text

Debug Levels

clog('Hello', verbose='DEBUG')
clog('Hello', verbose='INFO')
clog('Hello', verbose='WARNING')
clog('Hello', verbose='ERROR')
clog('Hello', verbose='CRITICAL')

alt text

Colors

clog('Hello', verbose='RED')
clog('Hello', verbose='GREEN')
clog('Hello', verbose='YELLOW')
clog('Hello', verbose='BLUE')
clog('Hello', verbose='MAGENTA')
clog('Hello', verbose='CYAN')

alt text

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

skylynx-0.1.1.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

skylynx-0.1.1-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

Supported by

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