8000 🔀 MERGE: v2 pypi branch · TechWiz-3/python-utils@b7d7ad2 · GitHub
[go: up one dir, main page]
Skip to content

Commit b7d7ad2

Browse files
TechWiz-3TechWiz-3
committed
🔀 MERGE: v2 pypi branch
2 parents 0b83438 + 6cc391b commit b7d7ad2

File tree

13 files changed

+254
-66
lines changed

13 files changed

+254
-66
lines changed

‎.gitignore

Lines changed: 153 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,153 @@
1-
.DS_STORE
2-
__pycache__
3-
*.swp
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/

‎README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
Random python utils I'm making for my own use. Also using this to apply some basic OOP
22

3+
```
4+
pip install wise-py-utils
5+
```
6+
7+
```py
8+
>>> from wise.<util_file> import <UtilClass>
9+
10+
# Example:
11+
>>> from wise.datetimeutils import GetDay
12+
```
13+
14+
315
Enter the specific directory to get more about each utility.
416

517
## :spiral_calendar: [datetime-utils](/datetime-utils)
@@ -12,3 +24,60 @@ Returns a string containing the weekday of the current or specified date.
1224
## :computer: [cpu-utils](/processor-utils)
1325

1426
## :pencil: [typo-remover](/enter-typos)
27+
28+
29+
# In depth info
30+
31+
# Datetime utils
32+
33+
## [get_day](get_day.py)
34+
The python datetime module is very versatile however as shown in [this](https://stackoverflow.com/questions/9847213/how-do-i-get-the-day-of-week-given-a-date) stackoverflow answer. **Getting a date's weekday as a string is not so simple.** Python's `datetime. datetime.weekday()` returns an integer, 0 for Monday ... ... and 6 for Sunday.
35+
36+
This module allows me to get a string containing the date (current or otherwise specified) with a single method.
37+
38+
### Examples
39+
40+
Simply get the current day of the week
41+
```py
42+
today = GetDay()
43+
print(today.get_weekday())
44+
45+
Output:
46+
'Saturday'
47+
```
48+
49+
Get the day of a specified date
50+
```py
51+
from datetime import datetime
52+
today = GetDay(datetime(2017, 2, 2))
53+
print(today.get_weekday())
54+
55+
Output:
56+
'Thursday'
57+
```
58+
59+
Get the day based on the weekday number using the `get_weekday_from_number() classmethod
60+
```py
61+
>>> import datetime
62+
>>> number = datetime.datetime.today().weekday()
63+
>>> print(number)
64+
1
65+
>>> print(GetDay.get_weekday_from_number(number))
66+
'Tuesday'
67+
``
68+
69+
# Enter typos
70+
71+
Often when hitting enter, I accidentally hit a key next to it. Often the resulting input can end up looking like this.
72+
73+
```py
74+
characters = ["/", "'" "\" "]"]
75+
input = "<regular input> <random-character><enter>"
76+
```
77+
78+
This library is designed to remove trailing special characters from strings and integers and return what the user actually mean to enter.
79+
80+
81+
# Scan files
82+
83+
Scans a specified file for a regex or string pattern and returns a list of all the results`

‎datetime-utils/README.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎enter-typos/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
psutil

‎scan-file/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎setup.py

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
from setuptools import setup, find_packages
2+
from src import wise as wise
3+
4+
with open('README.md') as f:
5+
long_description = f.read()
6+
7+
8+
with open('requirements.txt') as f:
9+
required = f.read().splitlines()
10+
11+
setup(
12+
name='wise-py-utils',
13+
author=wise.__author__,
14+
version=wise.__version__,
15+
description='Python utils created by Zac the Wise',
16+
long_description=long_description,
17+
long_description_content_type='text/markdown',
18+
url="https://github.com/techWiz-3/python-utils",
19+
keywords="python-utils python-utilities",
20+
packages=find_packages(
21+
where='src',
22+
),
23+
package_dir={"":"src"},
24+
install_requires=required,
25+
26+
)

‎src/wise/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Information
2+
__license__ = 'GPL3'
3+
__version__ = '0.0.1'
4+
__release__ = False
5+
__author__ = __maintainer__ = 'Zac the Wise'

‎datetime-utils/get_day.py renamed to ‎src/wise/datetimeutils.py

File renamed without changes.

‎processor-utils/process.py renamed to ‎src/wise/processor.py

File renamed without changes.

0 commit comments

Comments
 (0)
0