opendate 0.1.1__tar.gz

opendate-0.1.1/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 bissli
+Copyright (c) 2015 Sébastien Eustace
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

opendate-0.1.1/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: opendate
+Version: 0.1.1
+Summary: 
+Author: bissli
+Author-email: bissli.xyz@protonmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: test
+Requires-Dist: asserts ; extra == "test"
+Requires-Dist: bump2version ; extra == "test"
+Requires-Dist: pandas-market-calendars
+Requires-Dist: pdbpp ; extra == "test"
+Requires-Dist: pendulum
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: regex
+Requires-Dist: typing-extensions
+Requires-Dist: wrapt
+Description-Content-Type: text/markdown
+
+opendate
+========
+
+A wrapper around [Pendulum](https://github.com/sdispater/pendulum) with business (NYSE default, extendable) days/hours awareness.
+
+Documentation pending, see tests for examples. Functionality is near-identical to Pendulum with the exception of a business modifier.
+
+The main module is named `date` rather than `pendulum`
+
+Ex:
+
+```python
+
+from date import Date, DateTime, Time, Interval
+
+thedate = Date.today()
+
+# add days
+thedate.add(days=5)
+thedate.business().add(days=5) # add 5 business day
+
+# subtract days
+thedate.subtract(days=5)
+thedate.business().subtrat(days=5) # subtract 5 business day
+
+# start of month
+thedate.start_of('month')
+thedate.business().start_of('month') # end of month + N days until valid business day
+
+# end of month
+thedate.end_of('month')
+thedate.business().end_of('month') # end of month - N days until valid business day
+
+# ...
+
+```
+

opendate-0.1.1/README.md

@@ -0,0 +1,36 @@
+opendate
+========
+
+A wrapper around [Pendulum](https://github.com/sdispater/pendulum) with business (NYSE default, extendable) days/hours awareness.
+
+Documentation pending, see tests for examples. Functionality is near-identical to Pendulum with the exception of a business modifier.
+
+The main module is named `date` rather than `pendulum`
+
+Ex:
+
+```python
+
+from date import Date, DateTime, Time, Interval
+
+thedate = Date.today()
+
+# add days
+thedate.add(days=5)
+thedate.business().add(days=5) # add 5 business day
+
+# subtract days
+thedate.subtract(days=5)
+thedate.business().subtrat(days=5) # subtract 5 business day
+
+# start of month
+thedate.start_of('month')
+thedate.business().start_of('month') # end of month + N days until valid business day
+
+# end of month
+thedate.end_of('month')
+thedate.business().end_of('month') # end of month - N days until valid business day
+
+# ...
+
+```

opendate-0.1.1/pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "opendate"
+version = "0.1.1"
+description = ""
+authors = ["bissli <bissli.xyz@protonmail.com>"]
+readme = "README.md"
+packages = [{ include = "date", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+
+pandas-market-calendars = "*"
+pendulum = "*"
+wrapt = "*"
+typing-extensions = "*"
+regex = "*"
+
+# = test
+asserts = { version = "*", optional = true }
+pytest = { version = "*", optional = true }
+pdbpp = { version = "*", optional = true }
+bump2version = { version = "*", optional = true }
+
+[tool.poetry.extras]
+test = [
+  "asserts",
+  "pdbpp",
+  "pytest",
+  "bump2version",
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

opendate-0.1.1/src/date/__init__.py

@@ -0,0 +1,109 @@
+__version__ = '0.1.1'
+
+import datetime as _datetime
+
+import numpy as np
+import pandas as pd
+import pendulum as _pendulum
+import zoneinfo as _zoneinfo
+
+from typing_extensions import Optional
+from typing_extensions import Union
+from typing_extensions import overload
+
+from date.date import Date
+from date.date import DateTime
+from date.date import Entity
+from date.date import Interval
+from date.date import IntervalError
+from date.date import LCL
+from date.date import EST
+from date.date import GMT
+from date.date import UTC
+from date.date import NYSE
+from date.date import Time
+from date.date import WeekDay
+from date.date import WEEKDAY_SHORTNAME
+from date.date import expect_date
+from date.date import expect_datetime
+from date.date import expect_native_timezone
+from date.date import expect_utc_timezone
+from date.date import prefer_native_timezone
+from date.date import prefer_utc_timezone
+from date.date import Timezone
+from date.business import *
+
+
+timezone = Timezone
+
+
+def date(*args, **kwargs):
+    return Date(*args, **kwargs)
+
+
+def datetime(*args, **kwargs):
+    return DateTime(*args, **kwargs)
+
+
+def time(*args, **kwargs):
+    return Time(*args, **kwargs)
+
+
+def parse():
+    """Generic parser that guesses type"""
+    raise NotImplementedError(
+        'Generic parser not implemented, use Date or DateTime parsers'
+    )
+
+
+def instance(obj: _datetime.date | _datetime.datetime | _datetime.time) -> DateTime | Date | Time:
+    """
+    Create a DateTime/Date/Time instance from a datetime/date/time native one.
+    """
+    if isinstance(obj, DateTime | Date | Time):
+        return obj
+    if isinstance(obj, _datetime.date) and not isinstance(obj, _datetime.datetime):
+        return Date.instance(obj)
+    if isinstance(obj, _datetime.time):
+        return Time.instance(obj)
+    if isinstance(obj, _datetime.datetime):
+        return DateTime.instance(obj)
+
+
+def now(tz: str | _zoneinfo.ZoneInfo | None = None) -> DateTime:
+    """Get current datetime
+    """
+    return DateTime.now(tz)
+
+
+def today(tz: str | _zoneinfo.ZoneInfo = None) -> DateTime:
+    """Get current date
+    """
+    return DateTime.today(tz)
+
+
+__all__ = [
+    'Date',
+    'DateTime',
+    'Interval',
+    'IntervalError',
+    'Time',
+    'WeekDay',
+    'now',
+    'today',
+    'parse',
+    'LCL',
+    'timezone',
+    'expect_native_timezone',
+    'expect_utc_timezone',
+    'prefer_native_timezone',
+    'prefer_utc_timezone',
+    'expect_date',
+    'expect_datetime',
+    'Entity',
+    'NYSE',
+    'date',
+    'datetime',
+    'time'
+    'within_business_hours'
+    ]

opendate-0.1.1/src/date/business.py

@@ -0,0 +1,42 @@
+from date import NYSE, DateTime, Entity
+
+__all__ = ['is_within_business_hours', 'is_business_day']
+
+
+def is_within_business_hours(entity: Entity = NYSE) -> bool:
+    """Return whether the current native datetime is between
+    open and close of business hours.
+
+    >>> from unittest.mock import patch
+    >>> tz = NYSE.tz
+
+    >>> with patch('date.DateTime.now') as mock:
+    ...     mock.return_value = DateTime(2000, 5, 1, 12, 30, 0, 0, tzinfo=tz)
+    ...     is_within_business_hours()
+    True
+
+    >>> with patch('date.DateTime.now') as mock:
+    ...     mock.return_value = DateTime(2000, 7, 2, 12, 15, 0, 0, tzinfo=tz) # Sunday
+    ...     is_within_business_hours()
+    False
+
+    >>> with patch('date.DateTime.now') as mock:
+    ...     mock.return_value = DateTime(2000, 11, 1, 1, 15, 0, 0, tzinfo=tz)
+    ...     is_within_business_hours()
+    False
+
+    """
+    this = DateTime.now()
+    this_entity = DateTime.now(tz=entity.tz).entity(entity)
+    bounds = this_entity.business_hours()
+    return this_entity.business_open() and (bounds[0] <= this.astimezone(entity.tz) <= bounds[1])
+
+
+def is_business_day(entity: Entity = NYSE) -> bool:
+    """Return whether the current native datetime is a business day.
+    """
+    return DateTime.now(tz=entity.tz).entity(entity).is_business_day()
+
+
+if __name__ == '__main__':
+    __import__('doctest').testmod(optionflags=4 | 8 | 32)