batutils 2.2.0__tar.gz → 2.2.1__tar.gz

{batutils-2.2.0 → batutils-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: batutils
-Version: 2.2.0
+Version: 2.2.1
 Summary: Team Batcave's utilities for date and/or time objects and values and messing with types and so much more.
 Author-email: Thordur Matthiasson <doddi79@gmail.com>, John Aldis <johnaldis@ccpgames.com>
 License: MIT License
@@ -50,57 +50,69 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-# Team Batcave Python Toolkit
+# batutils - Team Batcave Python Toolkit
 
-The `batutils` is a fork of the `batutils` package in order to continue its 
-development and maintenance beyond Team Batcave's lifespan.  
+[![PyPI](https://img.shields.io/pypi/v/batutils)](https://pypi.org/project/batutils/)
 
-It is a smooshup of a few Python packages from the CCP Tools Team of old (Team 
-Batcave).
+A grab-bag of small, dependency-free Python utilities for working with dates
+and times and for everyday type juggling, originally written by Team Batcave
+at CCP Games.
 
-Our two most commonly used internal packages, called `datetimeutils` and 
-`typeutils` were too _generically_ named for Pypi.org and since they were 
-both used in something like 80-90% of our other projects, it made sense to 
-just smoosh them together in one module, and thus, the `batutils` package 
-was born.
-
-Here's the README of the [Date Time Utils](batutils/dtu/README.md) submodule.
-
-Here's the README of the [Type Utils](batutils/tpu/README.md) submodule.
+This is a fork of [`ccptools`](https://github.com/ccpgames/ccptools), kept alive
+beyond the original team's lifespan. Our two most commonly used internal packages,
+`datetimeutils` and `typeutils`, had names that were too generic for PyPI and were
+used in 80-90% of our other projects, so they were smooshed together into one
+package.
 
+```bash
+pip install batutils
+```
 
-### Changes from `ccptools`
+Requires Python 3.10 or newer.
 
-The `legacyapi` submodule has been removed.
+## What's inside
 
+| Submodule | Formerly | What it is | Docs |
+|-----------|----------|------------|------|
+| `batutils.dtu` | `datetimeutils` | Casting, parsing, formatting and shortcuts for date/time values | [Date/Time Utils](batutils/dtu/README.md) |
+| `batutils.tpu` | `typeutils` | Safe type evaluation, nested dict/list helpers, enums, singletons, serializers and more | [Type Utils](batutils/tpu/README.md) |
+| `batutils.structs` | | One-line "usual imports" for your modules | [below](#common-imports) |
 
-## Date-Time Utils
+**Looking for a specific function?** Use the task-oriented
+[Public API index](docs/api-index.md).
 
-The old `datetimeutils` package is now included here as the `dtu` submodule.
+## Quick taste
 
 ```python
 from batutils import dtu
+from batutils.tpu.casting import int_eval, bool_eval
+from batutils.tpu.iters import nested_get
+
+dtu.any_to_datetime('2024-04-02 13:47:25')   # datetime(2024, 4, 2, 13, 47, 25)
+dtu.agostr(dtu.ago(days=5))                  # '5 days'
+int_eval('0x10')                             # 16
+bool_eval('Yes')                             # True
+nested_get({'a': {'b': [1, 2, 3]}}, ('a', 'b', -1))   # 3
 ```
 
-## Structs
+## Common imports
+
+`from batutils.structs import *` pulls in the imports that nearly every file in
+our projects needs:
 
-Importing `*` from the `structs` submodule will import all of the most 
-commonly used imports in our projects:
 ```python
-from typing import *  # For type annotation
-
-import abc  # For interfaces (Abstract Base Classes)
-import dataclasses  # For dataclass structs
-import decimal  # Used whenever we're handling money
-import enum  # Also used for struct creation
-import logging  # Used pretty much everywhere
-import re  # Used surprisingly frequently
-import time  # Very commonly used
+from typing import *       # for type annotations
+import abc                 # interfaces (Abstract Base Classes)
+import dataclasses         # dataclass structs
+import decimal             # anything involving money
+import enum                # also used for struct creation
+import logging             # used pretty much everywhere
+import re                  # used surprisingly frequently
+import time                # very commonly used
 ```
 
-Note that datetime is not included in this. That's because tt'll also import 
-the aliases from the Datetime Utils (`batutils.dtu.structs.aliases`) 
-package instead:
+`datetime` itself is not included. Instead you get the date/time aliases from
+`batutils.dtu.structs.aliases`:
 
 ```python
 Date = datetime.date
@@ -111,16 +123,25 @@ TzInfo = datetime.tzinfo
 TimeZone = datetime.timezone
 ```
 
-Furthermore, it'll also include a few of the most commonly used utility 
-classes from the Type Utils submodule:
+Plus a few of the most commonly used helpers from the type utils:
 
-- The `Singleton` Meta Class 
-- The `Empty` and `EmptyDict` classes as well as the `if_empty` method
-- The `EnumEx` base class for Enums with the `from_any` class method
+- the `Singleton` metaclass
+- `Empty`, `EmptyDict` and `if_empty`
+- the `EnumEx` base class for enums (adds the `from_any` class method)
 
-So in most cases we can cover something like 90% of any imports we tend to 
-need in every Python file with a single line:
+So one line covers roughly 90% of the imports we need in any given file:
 
 ```python
 from batutils.structs import *
 ```
+
+## Changes from `ccptools`
+
+The `legacyapi` submodule has been removed. See the [changelog](CHANGELOG.md)
+for the full history.
+
+## Contributing and license
+
+Issues and pull requests are welcome at
+[github.com/doddi79/batutils](https://github.com/doddi79/batutils). Released
+under the [MIT License](LICENSE).

batutils-2.2.1/README.md

@@ -0,0 +1,95 @@
+# batutils - Team Batcave Python Toolkit
+
+[![PyPI](https://img.shields.io/pypi/v/batutils)](https://pypi.org/project/batutils/)
+
+A grab-bag of small, dependency-free Python utilities for working with dates
+and times and for everyday type juggling, originally written by Team Batcave
+at CCP Games.
+
+This is a fork of [`ccptools`](https://github.com/ccpgames/ccptools), kept alive
+beyond the original team's lifespan. Our two most commonly used internal packages,
+`datetimeutils` and `typeutils`, had names that were too generic for PyPI and were
+used in 80-90% of our other projects, so they were smooshed together into one
+package.
+
+```bash
+pip install batutils
+```
+
+Requires Python 3.10 or newer.
+
+## What's inside
+
+| Submodule | Formerly | What it is | Docs |
+|-----------|----------|------------|------|
+| `batutils.dtu` | `datetimeutils` | Casting, parsing, formatting and shortcuts for date/time values | [Date/Time Utils](batutils/dtu/README.md) |
+| `batutils.tpu` | `typeutils` | Safe type evaluation, nested dict/list helpers, enums, singletons, serializers and more | [Type Utils](batutils/tpu/README.md) |
+| `batutils.structs` | | One-line "usual imports" for your modules | [below](#common-imports) |
+
+**Looking for a specific function?** Use the task-oriented
+[Public API index](docs/api-index.md).
+
+## Quick taste
+
+```python
+from batutils import dtu
+from batutils.tpu.casting import int_eval, bool_eval
+from batutils.tpu.iters import nested_get
+
+dtu.any_to_datetime('2024-04-02 13:47:25')   # datetime(2024, 4, 2, 13, 47, 25)
+dtu.agostr(dtu.ago(days=5))                  # '5 days'
+int_eval('0x10')                             # 16
+bool_eval('Yes')                             # True
+nested_get({'a': {'b': [1, 2, 3]}}, ('a', 'b', -1))   # 3
+```
+
+## Common imports
+
+`from batutils.structs import *` pulls in the imports that nearly every file in
+our projects needs:
+
+```python
+from typing import *       # for type annotations
+import abc                 # interfaces (Abstract Base Classes)
+import dataclasses         # dataclass structs
+import decimal             # anything involving money
+import enum                # also used for struct creation
+import logging             # used pretty much everywhere
+import re                  # used surprisingly frequently
+import time                # very commonly used
+```
+
+`datetime` itself is not included. Instead you get the date/time aliases from
+`batutils.dtu.structs.aliases`:
+
+```python
+Date = datetime.date
+Time = datetime.time
+Datetime = datetime.datetime
+TimeDelta = datetime.timedelta
+TzInfo = datetime.tzinfo
+TimeZone = datetime.timezone
+```
+
+Plus a few of the most commonly used helpers from the type utils:
+
+- the `Singleton` metaclass
+- `Empty`, `EmptyDict` and `if_empty`
+- the `EnumEx` base class for enums (adds the `from_any` class method)
+
+So one line covers roughly 90% of the imports we need in any given file:
+
+```python
+from batutils.structs import *
+```
+
+## Changes from `ccptools`
+
+The `legacyapi` submodule has been removed. See the [changelog](CHANGELOG.md)
+for the full history.
+
+## Contributing and license
+
+Issues and pull requests are welcome at
+[github.com/doddi79/batutils](https://github.com/doddi79/batutils). Released
+under the [MIT License](LICENSE).

{batutils-2.2.0 → batutils-2.2.1}/batutils/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.2.0'
+__version__ = '2.2.1'
 
 __author__ = 'Thordur Matthiasson <doddi79@gmail.com>'
 __license__ = 'MIT License'

{batutils-2.2.0 → batutils-2.2.1}/batutils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: batutils
-Version: 2.2.0
+Version: 2.2.1
 Summary: Team Batcave's utilities for date and/or time objects and values and messing with types and so much more.
 Author-email: Thordur Matthiasson <doddi79@gmail.com>, John Aldis <johnaldis@ccpgames.com>
 License: MIT License
@@ -50,57 +50,69 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-# Team Batcave Python Toolkit
+# batutils - Team Batcave Python Toolkit
 
-The `batutils` is a fork of the `batutils` package in order to continue its 
-development and maintenance beyond Team Batcave's lifespan.  
+[![PyPI](https://img.shields.io/pypi/v/batutils)](https://pypi.org/project/batutils/)
 
-It is a smooshup of a few Python packages from the CCP Tools Team of old (Team 
-Batcave).
+A grab-bag of small, dependency-free Python utilities for working with dates
+and times and for everyday type juggling, originally written by Team Batcave
+at CCP Games.
 
-Our two most commonly used internal packages, called `datetimeutils` and 
-`typeutils` were too _generically_ named for Pypi.org and since they were 
-both used in something like 80-90% of our other projects, it made sense to 
-just smoosh them together in one module, and thus, the `batutils` package 
-was born.
-
-Here's the README of the [Date Time Utils](batutils/dtu/README.md) submodule.
-
-Here's the README of the [Type Utils](batutils/tpu/README.md) submodule.
+This is a fork of [`ccptools`](https://github.com/ccpgames/ccptools), kept alive
+beyond the original team's lifespan. Our two most commonly used internal packages,
+`datetimeutils` and `typeutils`, had names that were too generic for PyPI and were
+used in 80-90% of our other projects, so they were smooshed together into one
+package.
 
+```bash
+pip install batutils
+```
 
-### Changes from `ccptools`
+Requires Python 3.10 or newer.
 
-The `legacyapi` submodule has been removed.
+## What's inside
 
+| Submodule | Formerly | What it is | Docs |
+|-----------|----------|------------|------|
+| `batutils.dtu` | `datetimeutils` | Casting, parsing, formatting and shortcuts for date/time values | [Date/Time Utils](batutils/dtu/README.md) |
+| `batutils.tpu` | `typeutils` | Safe type evaluation, nested dict/list helpers, enums, singletons, serializers and more | [Type Utils](batutils/tpu/README.md) |
+| `batutils.structs` | | One-line "usual imports" for your modules | [below](#common-imports) |
 
-## Date-Time Utils
+**Looking for a specific function?** Use the task-oriented
+[Public API index](docs/api-index.md).
 
-The old `datetimeutils` package is now included here as the `dtu` submodule.
+## Quick taste
 
 ```python
 from batutils import dtu
+from batutils.tpu.casting import int_eval, bool_eval
+from batutils.tpu.iters import nested_get
+
+dtu.any_to_datetime('2024-04-02 13:47:25')   # datetime(2024, 4, 2, 13, 47, 25)
+dtu.agostr(dtu.ago(days=5))                  # '5 days'
+int_eval('0x10')                             # 16
+bool_eval('Yes')                             # True
+nested_get({'a': {'b': [1, 2, 3]}}, ('a', 'b', -1))   # 3
 ```
 
-## Structs
+## Common imports
+
+`from batutils.structs import *` pulls in the imports that nearly every file in
+our projects needs:
 
-Importing `*` from the `structs` submodule will import all of the most 
-commonly used imports in our projects:
 ```python
-from typing import *  # For type annotation
-
-import abc  # For interfaces (Abstract Base Classes)
-import dataclasses  # For dataclass structs
-import decimal  # Used whenever we're handling money
-import enum  # Also used for struct creation
-import logging  # Used pretty much everywhere
-import re  # Used surprisingly frequently
-import time  # Very commonly used
+from typing import *       # for type annotations
+import abc                 # interfaces (Abstract Base Classes)
+import dataclasses         # dataclass structs
+import decimal             # anything involving money
+import enum                # also used for struct creation
+import logging             # used pretty much everywhere
+import re                  # used surprisingly frequently
+import time                # very commonly used
 ```
 
-Note that datetime is not included in this. That's because tt'll also import 
-the aliases from the Datetime Utils (`batutils.dtu.structs.aliases`) 
-package instead:
+`datetime` itself is not included. Instead you get the date/time aliases from
+`batutils.dtu.structs.aliases`:
 
 ```python
 Date = datetime.date
@@ -111,16 +123,25 @@ TzInfo = datetime.tzinfo
 TimeZone = datetime.timezone
 ```
 
-Furthermore, it'll also include a few of the most commonly used utility 
-classes from the Type Utils submodule:
+Plus a few of the most commonly used helpers from the type utils:
 
-- The `Singleton` Meta Class 
-- The `Empty` and `EmptyDict` classes as well as the `if_empty` method
-- The `EnumEx` base class for Enums with the `from_any` class method
+- the `Singleton` metaclass
+- `Empty`, `EmptyDict` and `if_empty`
+- the `EnumEx` base class for enums (adds the `from_any` class method)
 
-So in most cases we can cover something like 90% of any imports we tend to 
-need in every Python file with a single line:
+So one line covers roughly 90% of the imports we need in any given file:
 
 ```python
 from batutils.structs import *
 ```
+
+## Changes from `ccptools`
+
+The `legacyapi` submodule has been removed. See the [changelog](CHANGELOG.md)
+for the full history.
+
+## Contributing and license
+
+Issues and pull requests are welcome at
+[github.com/doddi79/batutils](https://github.com/doddi79/batutils). Released
+under the [MIT License](LICENSE).

{batutils-2.2.0 → batutils-2.2.1}/batutils.egg-info/top_level.txt

@@ -1 +1,2 @@
 batutils
+docs

batutils-2.2.0/README.md

@@ -1,74 +0,0 @@
-# Team Batcave Python Toolkit
-
-The `batutils` is a fork of the `batutils` package in order to continue its 
-development and maintenance beyond Team Batcave's lifespan.  
-
-It is a smooshup of a few Python packages from the CCP Tools Team of old (Team 
-Batcave).
-
-Our two most commonly used internal packages, called `datetimeutils` and 
-`typeutils` were too _generically_ named for Pypi.org and since they were 
-both used in something like 80-90% of our other projects, it made sense to 
-just smoosh them together in one module, and thus, the `batutils` package 
-was born.
-
-Here's the README of the [Date Time Utils](batutils/dtu/README.md) submodule.
-
-Here's the README of the [Type Utils](batutils/tpu/README.md) submodule.
-
-
-### Changes from `ccptools`
-
-The `legacyapi` submodule has been removed.
-
-
-## Date-Time Utils
-
-The old `datetimeutils` package is now included here as the `dtu` submodule.
-
-```python
-from batutils import dtu
-```
-
-## Structs
-
-Importing `*` from the `structs` submodule will import all of the most 
-commonly used imports in our projects:
-```python
-from typing import *  # For type annotation
-
-import abc  # For interfaces (Abstract Base Classes)
-import dataclasses  # For dataclass structs
-import decimal  # Used whenever we're handling money
-import enum  # Also used for struct creation
-import logging  # Used pretty much everywhere
-import re  # Used surprisingly frequently
-import time  # Very commonly used
-```
-
-Note that datetime is not included in this. That's because tt'll also import 
-the aliases from the Datetime Utils (`batutils.dtu.structs.aliases`) 
-package instead:
-
-```python
-Date = datetime.date
-Time = datetime.time
-Datetime = datetime.datetime
-TimeDelta = datetime.timedelta
-TzInfo = datetime.tzinfo
-TimeZone = datetime.timezone
-```
-
-Furthermore, it'll also include a few of the most commonly used utility 
-classes from the Type Utils submodule:
-
-- The `Singleton` Meta Class 
-- The `Empty` and `EmptyDict` classes as well as the `if_empty` method
-- The `EnumEx` base class for Enums with the `from_any` class method
-
-So in most cases we can cover something like 90% of any imports we tend to 
-need in every Python file with a single line:
-
-```python
-from batutils.structs import *
-```