Metadata-Version: 2.4
Name: strify-tools-141211
Version: 0.0.1
Summary: A Python library for working with strings.
Author: Davi Sena
Author-email: senasacchetto@gmail.com
License: MIT
Keywords: string text manipulation
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: summary

# Strify

**A lightweight Python library for simple and convenient string manipulation.**

Strify provides a collection of straightforward utilities for common string manipulation and text-cleaning tasks, with the goal of making repetitive operations simpler and more readable.

## Installation

Install Strify directly from PyPI:

```bash
pip install strify
```

## Quick Start

```python
import strify

text = "Hello     World"

cleaned = strify.del_double_spaces(text)

print(cleaned)
```

Output:

```text
Hello World
```

## Features

Strify currently provides utilities for:

* Joining strings
* Removing spaces
* Splitting strings
* Replacing text
* Checking whether a string contains another string
* Removing consecutive spaces
* Removing specific characters

## API Reference

### `join(str1, str2)`

Joins two values together using the `+` operator.

```python
strify.join("Hello ", "World")
```

Output:

```text
Hello World
```

---

### `del_spaces(string)`

Removes all space characters from a string.

```python
strify.del_spaces("Hello World")
```

Output:

```text
HelloWorld
```

---

### `split(string, separator)`

Splits a string using the specified separator.

```python
strify.split("Hello,World,Python", ",")
```

Output:

```python
["Hello", "World", "Python"]
```

---

### `replace(string, old, new)`

Replaces occurrences of a substring with another substring.

```python
strify.replace("I like Python", "Python", "C++")
```

Output:

```text
I like C++
```

---

### `is_in_string(str1, str2)`

Checks whether `str1` exists inside `str2`.

```python
strify.is_in_string("Python", "I like Python")
```

Output:

```text
True
```

---

### `del_double_spaces(string)`

Replaces consecutive whitespace with a single space.

```python
strify.del_double_spaces("Hello     World")
```

Output:

```text
Hello World
```

---

### `remove_char(string, char)`

Removes all occurrences of a specified character.

```python
strify.remove_char("Hello!", "!")
```

Output:

```text
Hello
```

## Why Strify?

Python already provides powerful built-in string methods. Strify is designed to group frequently used string operations into a simple and consistent interface.

Instead of repeatedly writing combinations of built-in operations, you can use concise functions for common tasks:

```python
# Without Strify
cleaned = " ".join(text.split())

# With Strify
cleaned = strify.del_double_spaces(text)
```

## Requirements

Strify is designed for Python 3.

## Development

Clone the repository:

```bash
git clone git@github.com:YOUR_USERNAME/strify.git
cd strify
```

Install the package in editable mode:

```bash
pip install -e .
```

## Testing

Tests can be run with:

```bash
pytest
```

## Contributing

Contributions, bug reports, and suggestions are welcome.

If you would like to contribute:

1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Add or update tests.
5. Submit a pull request.

## License

This project is licensed under the MIT License. See the `LICENSE` file for details.

## Author

Created by **Davi Sena**.
