Metadata-Version: 2.1
Name: zyncify
Version: 0.1.6
Summary: zync is a utility tool for python operations
Home-page: https://github.com/tjbredemeyer/zync
Author: TJ Bredemeyer
Author-email: tj@teicor.com
License: GNU Public License v3
Description-Content-Type: text/markdown
License-File: LICENSE

# zync

zync is a utility tool for python operations.

[![zync-ci](https://github.com/tjbredemeyer/zync/actions/workflows/ci.yml/badge.svg)](https://github.com/tjbredemeyer/zync/actions/workflows/ci.yml)

## INSTALLATION

```bash
pip install zyncify
```

## Usage

### 1. IMPORT

```python
from zync import *
```

### 2. FUNCTIONS

#### logger

logger takes in a string and logs it with an INFO level.  

```python
from zync import logger

# logging a string INFO
logger("info message")

# logging a variable INFO
message = "info message"
logger(message)

###
# returns: INFO info message
```  

#### bugger

bugger takes in a string and logs it with a DEBUG level.  

```python
from zync import bugger

# logging a string DEBUG
bugger("debug message")

# logging a variable DEBUG
message = "debug message"
bugger(message)

###
# returns: DEBUG debug message
```  

#### egger

egger takes in a string and logs it with an ERROR level.  

```python
from zync import egger

# logging a string ERROR
egger("error message")

# logging a variable ERROR
message = "error message"
egger(message)

###
# returns: ERROR debug message
```  

#### Slugger  

Slugger converts a string to slug while maintaining capitalization.  

```python
from zync import Slugger

# Slugging a string with Caps
Slugger("Test String")

# Slugging a variable with caps
string = "Test String"
Slugger(string)

###
# returns: Test-String
```  
  
#### slugger  

slugger converts a string to a slug with no capitalization.

```python
from zync import slugger

# Slugging a string without Caps
slugger("Test String")

# Slugging a variable without caps
string = "Test String"
slugger(string)

###
# returns: test-string
```  

### 3. TAIL LOG FILE

```bash
tail -f ./.zync.log
```

## Author

TJ Bredemeyer  
twitter: @tjbredemeyer
