pyprefab 0.2.0__py3-none-any.whl

hello_world/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.3'

hello_world/app.py

@@ -0,0 +1,20 @@
+import structlog
+
+from hello_world.util.date import get_current_date
+from hello_world.util.logs import setup_logging
+
+setup_logging()
+logger = structlog.get_logger()
+
+
+def main():
+    """Application entry point."""
+
+    today = get_current_date()
+    logger.info('retrieved the date', date=today)
+
+    return f'Hello, today is {today}!'
+
+
+if __name__ == '__main__':
+    main()

hello_world/util/date.py

@@ -0,0 +1,15 @@
+import datetime
+
+import structlog
+
+logger = structlog.get_logger()
+
+
+def get_current_date() -> str:
+    """Return current date in human-readable format."""
+
+    logger.info('getting the current date')
+    current_date = datetime.datetime.now()
+    formatted_date = current_date.strftime('%B %d, %Y')
+
+    return formatted_date

hello_world/util/logs.py

@@ -0,0 +1,41 @@
+import sys
+
+import structlog
+
+import hello_world
+
+
+def add_custom_info(logger, method_name, event_dict):
+    event_dict['version'] = hello_world.__version__
+    return event_dict
+
+
+def setup_logging():
+    shared_processors = [
+        add_custom_info,
+        structlog.processors.TimeStamper(fmt='iso'),
+        structlog.processors.add_log_level,
+        structlog.processors.CallsiteParameterAdder(
+            [
+                structlog.processors.CallsiteParameter.FILENAME,
+                structlog.processors.CallsiteParameter.FUNC_NAME,
+            ]
+        ),
+    ]
+
+    if sys.stderr.isatty():
+        # If we're in a terminal, pretty print the logs.
+        processors = shared_processors + [
+            structlog.dev.ConsoleRenderer(),
+        ]
+    else:
+        # Otherwise, output logs in JSON format
+        processors = shared_processors + [
+            structlog.processors.dict_tracebacks,
+            structlog.processors.JSONRenderer(),
+        ]
+
+    structlog.configure(
+        processors=processors,
+        cache_logger_on_first_use=True,
+    )

pyprefab-0.2.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Becky Sweger
+
+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.

pyprefab-0.2.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.2
+Name: pyprefab
+Version: 0.2.0
+Summary: Python application template for personal use
+License: MIT License
+Project-URL: Repository, https://github.com/bsweger/pyprefab.git
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: structlog
+Requires-Dist: rich
+
+# pyprefab
+
+A Python template for personal use. The package itself doesn't do much, but I
+keep it up to date as my Python workflow and tooling preferences evolve.
+
+## Installing and running the package (no development)
+
+To install this package via pip:
+
+```bash
+pip install git+https://github.com/bsweger/pyprefab.git
+```
+
+To run it:
+
+```bash
+hello_world
+```
+
+## Setup for local development
+
+The instructions below outline how to set up a development environment based
+on uv tooling.
+
+Prerequisites:
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+1. Clone this repository
+2. Change to the repo's root directory:
+
+    ```bash
+    cd pyprefab
+    ```
+
+3. Create a Python virtual environment and install dependencies. The command
+below creates a virtual environment in the `.venv` directory, installs Python
+if needed, installs project dependencies (including dev dependencies), and
+installs the package in
+[editable mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html):
+
+    ```bash
+    uv sync
+    ```
+
+4. Run the test suite to confirm that everything is working:
+
+    ```bash
+    uv run pytest
+    ```
+
+### Updating dependencies
+
+Use [`uv add`](https://docs.astral.sh/uv/reference/cli/#uv-add) to include a
+new dependency in the project. This command will install the new dependency
+into the virtual environment, add it to `uv.lock`, and update the
+`dependencies` section of [`pyproject.toml`](pyproject.toml).
+
+```bash
+uv add <package-name>
+```
+
+To add a dependency to a specific group (adding a dev dependency, for example),
+use the `--group` flag:
+
+```bash
+uv add <package-name> --group dev
+```

pyprefab-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+hello_world/__init__.py,sha256=yyLtGsBhynC-sSHdax-rRGvHNjH-gdWxIY68WnPVfDw,22
+hello_world/app.py,sha256=b2g8sI5oxPZzh47JY3Vxiirg8ZxcMuuiJNJkI84umLo,377
+hello_world/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hello_world/util/date.py,sha256=wQTb-vtB4xxBGg0C9nlbwd23OcfLRw1pZsIi5QKm5Uw,327
+hello_world/util/logs.py,sha256=wsLzyedm_jNKT917kPnWjaVNx0JJIAeIsH49hZMik9s,1076
+pyprefab-0.2.0.dist-info/LICENSE,sha256=Is9RG0xG5jLBaEjfwOYJvkwUYhH7SYdNKaIHtwwk8hk,1068
+pyprefab-0.2.0.dist-info/METADATA,sha256=d2A6GDUIwvuRlMBv_AHj1C1pRRsg9tTwbnBms6Ad7sk,2062
+pyprefab-0.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pyprefab-0.2.0.dist-info/entry_points.txt,sha256=XIZcyRINylRXwE_TGh-BzJBrQ2nl0plC0dhWBSJXHKw,53
+pyprefab-0.2.0.dist-info/top_level.txt,sha256=vY8b2A8Sa2-5PUXRoDjDABQ-zMBnaxTqNarDpG9ub2s,12
+pyprefab-0.2.0.dist-info/RECORD,,

pyprefab-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyprefab-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hello_world = hello_world.app:main

pyprefab-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+hello_world