Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddc/ddcutils
Few Utility Functions
https://github.com/ddc/ddcutils
python3 utilities utilities-library utility utility-library utils utils-library
Last synced: 8 days ago
JSON representation
Few Utility Functions
- Host: GitHub
- URL: https://github.com/ddc/ddcutils
- Owner: ddc
- License: mit
- Created: 2024-01-09T23:56:51.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-22T19:45:21.000Z (9 months ago)
- Last Synced: 2024-04-23T20:28:55.370Z (8 months ago)
- Topics: python3, utilities, utilities-library, utility, utility-library, utils, utils-library
- Language: Python
- Homepage:
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# File Utilities
Few File Utilities and some OS Functions
[](https://www.paypal.com/ncp/payment/6G9Z78QHUD4RJ)
[](https://github.com/ddc/ddcUtils/blob/master/LICENSE)
[](https://pypi.python.org/pypi/ddcUtils)
[](https://pepy.tech/projects/ddcUtils)
[](https://codecov.io/gh/ddc/ddcUtils)
[](https://github.com/psf/black)
[](https://actions-badge.atrox.dev/ddc/ddcUtils/goto?ref=main)
[](https://www.python.org)
# Install
```shell
pip install ddcUtils
```
# Conf File Utils
File example - file.ini:
[main]
files=5
path="/tmp/test_dir"
port=5432
list=1,2,3,4,5,6
+ GET_ALL_VALUES
+ Get all values from an .ini config file structure and returns them as a dictionary
+ mixed_values will return all values as an object instead of dict
```python
from ddcUtils import ConfFileUtils
cfu = ConfFileUtils()
cfu.get_all_values(file_path, mixed_values=False)
```
+ GET_SECTION_VALUES
+ Get all section values from an .ini config file structure and returns them as a dictionary
```python
from ddcUtils import ConfFileUtils
cfu = ConfFileUtils()
cfu.get_section_values(file_path, section)
```
+ GET_VALUE
+ Get value from an .ini config file structure and returns it
```python
from ddcUtils import ConfFileUtils
cfu = ConfFileUtils()
cfu.get_value(file_path, section, config_name)
```
+ SET_VALUE
+ Set value from an .ini config file structure and returns True or False
```python
from ddcUtils import ConfFileUtils
cfu = ConfFileUtils()
cfu.set_value(file_path, section_name, config_name, new_value, commas=False)
```
# File Utils
+ OPEN
+ Open the given file or directory in explorer or notepad and returns True for success or False for failed access
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.open(path)
```
+ LIST_FILES
+ List all files in the given directory and returns them in a tuple sorted by creation time in ascending order
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.list_files(directory, starts_with, ends_with)
```
+ GZIP
+ Compress the given file and returns the Path for success or None if failed
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.gzip(input_file_path, output_dir=None)
```
+ UNZIP
+ Unzips the given file.zip and returns ZipFile for success or None if failed
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.unzip(file_path, out_pathNone)
```
+ REMOVE
+ Remove the given file or dir and returns True if it was successfully removed
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.remove(path)
```
+ RENAME
+ Rename the given file and returns True if the file was successfully
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.rename(from_name, to_name)
```
+ COPY_DIR
+ Copy files from src to dst and returns True or False
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.copy_dir(src, dst, symlinks=False, ignore=None)
```
+ DOWNLOAD_FILE
+ Download file from remote url to local and returns True or False
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.download_file(remote_file_url, local_file_path)
```
+ GET_EXE_BINARY_TYPE
+ Returns the binary type of the given windows EXE file
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.get_exe_binary_type(file_path)
```
+ IS_OLDER_THAN_X_DAYS
+ Check if a file or directory is older than the specified number of days
```python
from ddcUtils import FileUtils
fu = FileUtils()
fu.is_older_than_x_days(path, days)
```
+ COPY
+ Copy a file to another location
```python
from ddcUtils import FileUtils
fu = FileUtils()
copy(src_path, dst_path)
```
# Object
+ This class is used for creating a simple class object
```python
from ddcUtils import Object
obj = Object()
obj.test = "test"
```
# Misc Utils
+ CLEAR_SCREEN
+ Clears the terminal screen
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.clear_screen()
```
+ USER_CHOICE
+ This function will ask the user to select an option
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.user_choice()
```
+ GET_ACTIVE_BRANCH_NAME
+ Returns the name of the active branch if found, else returns None
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.get_active_branch_name(git_dir=".git")
```
+ GET_CURRENT_DATE_TIME
+ Returns the current date and time on UTC timezone
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.get_current_date_time()
```
+ CONVERT_DATETIME_TO_STR_LONG
+ Converts a datetime object to a long string
+ returns: "Mon Jan 01 2024 21:43:04"
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.convert_datetime_to_str_long(date)
```
+ CONVERT_DATETIME_TO_STR_SHORT
+ Converts a datetime object to a short string
+ returns: "2024-01-01 00:00:00.000000"
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.convert_datetime_to_str_short(date)
```
+ CONVERT_STR_TO_DATETIME_SHORT
+ Converts a str to a datetime
+ input: "2024-01-01 00:00:00.000000"
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.convert_str_to_datetime_short(datetime_str)
```
+ GET_CURRENT_DATE_TIME_STR_LONG
+ Returns the current date and time as string
+ returns: "Mon Jan 01 2024 21:47:00"
```python
from ddcUtils import MiscUtils
mu = MiscUtils()
mu.get_current_date_time_str_long()
```
# OS Utils
+ GET_OS_NAME
+ Get OS name
```python
from ddcUtils import OsUtils
ou = OsUtils()
get_os_name()
```
+ IS_WINDOWS
+ Check if OS is Windows
```python
from ddcUtils import OsUtils
ou = OsUtils()
is_windows()
```
+ GET_CURRENT_PATH
+ Returns the current working directory
```python
from ddcUtils import OsUtils
ou = OsUtils()
get_current_path()
```
+ GET_PICTURES_PATH
+ Returns the pictures directory inside the user's home directory
```python
from ddcUtils import OsUtils
ou = OsUtils()
get_pictures_path()
```
+ GET_DOWNLOADS_PATH
+ Returns the download directory inside the user's home directory
```python
from ddcUtils import OsUtils
ou = OsUtils()
get_downloads_path()
```
# Source Code
### Build
```shell
poetry build -f wheel
```
# Run Tests and Get Coverage Report using Poe
```shell
poetry update --with test
poe tests
```
# License
Released under the [MIT License](LICENSE)
# Buy me a cup of coffee
+ [GitHub Sponsor](https://github.com/sponsors/ddc)
+ [ko-fi](https://ko-fi.com/ddcsta)
+ [Paypal](https://www.paypal.com/ncp/payment/6G9Z78QHUD4RJ)