|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to the FunStrings package will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [0.1.2] - 2024-05-01 |
| 9 | + |
| 10 | +### Added |
| 11 | +- Connect section in README with GitHub and LinkedIn links |
| 12 | +- Added 5 Data Cleaning Functions: |
| 13 | + - `remove_html_tags`: Strip all HTML tags from text |
| 14 | + - `remove_emojis`: Remove emojis from text |
| 15 | + - `remove_special_characters`: Keep only letters and numbers |
| 16 | + - `expand_contractions`: Convert contractions like "don't" to "do not" |
| 17 | + - `correct_whitespace`: Remove weird spaces, tabs, newlines |
| 18 | + |
| 19 | +- Added 5 Text Analysis Helpers: |
| 20 | + - `unique_words`: Return list of unique words |
| 21 | + - `most_common_word`: Return most frequent word |
| 22 | + - `sentence_count`: Number of sentences in text |
| 23 | + - `average_sentence_length`: Average words per sentence |
| 24 | + - `character_ratio`: Uppercase/lowercase/number ratio |
| 25 | + |
| 26 | +- Added 4 ML/NLP Preprocessing Functions: |
| 27 | + - `generate_ngrams`: Generate list of n-grams |
| 28 | + - `strip_accents`: Remove accents (café → cafe) |
| 29 | + - `lemmatize_text`: Reduce words to base form |
| 30 | + - `is_ascii`: Check if text only contains ASCII |
| 31 | + |
| 32 | +- Added 5 Validation Functions: |
| 33 | + - `is_valid_email`: Validate if a string is a proper email |
| 34 | + - `is_valid_url`: Validate if a string is a proper URL |
| 35 | + - `is_valid_ip`: Check if string is a valid IP address |
| 36 | + - `is_valid_date`: Check if a string matches a date format |
| 37 | + - `contains_special_characters`: Check if special symbols are present |
| 38 | + |
| 39 | +### Documentation |
| 40 | +- Updated README.md with new function categories |
| 41 | +- Added examples for all new functions |
| 42 | +- Created new example file: v0.1.1_functions_demo.py |
| 43 | +- Added comprehensive test suite for new functions |
| 44 | + |
| 45 | +## [0.1.1] - 2024-04-23 |
| 46 | + |
| 47 | +### Added |
| 48 | +- Added badges to README.md (PyPI version, downloads, Python versions, license, etc.) |
| 49 | +- Added Table of Contents to README.md for better navigation |
| 50 | +- Added Contributing section to README.md |
| 51 | +- Added License section to README.md |
| 52 | +- Created CHANGELOG.md file to track changes |
| 53 | + |
| 54 | +### Changed |
| 55 | +- Renamed package from "stringfun" to "funstrings" |
| 56 | +- Updated all import statements and references in documentation |
| 57 | +- Improved README.md with more detailed information |
| 58 | + |
| 59 | +## [0.1.0] - 2024-04-22 |
| 60 | + |
| 61 | +### Added |
| 62 | +- Initial release of the package |
| 63 | +- Basic string operations (reverse, count vowels/consonants, palindrome check, etc.) |
| 64 | +- Text analysis functions (word frequencies, longest/shortest word, etc.) |
| 65 | +- String transformation functions (snake_to_camel, camel_to_snake, rotate, shuffle, etc.) |
| 66 | +- Pattern-based functions (extract numbers/emails/URLs, mask sensitive data, etc.) |
| 67 | +- Comprehensive documentation and examples |
| 68 | +- Educational tutorials for beginners and students |
0 commit comments