water-bottle-please 0.6.4__py3-none-any.whl

water_bottle_please/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from test-project!")

water_bottle_please/helpers.py

@@ -0,0 +1,157 @@
+import polars as pl
+from datetime import datetime
+from datetime import date
+
+def date_format(col: str,output_date_name = "output_date_name"):
+    """ Format Dates
+
+    Convert string dates into a yyyy-mm-dd format. 
+    The function uses pl.coalesce to try to process different formats.
+    For example, it will first try to convert m/d/y, and then if that doesn't work it will try d/m/y.
+    It's not perfect, but if someone messes up the date it's their fault.
+    
+    **Note: it won't attempt to convert excel dates. If someone sends us excel dates we will file a lawsuit.**
+
+    Usage
+    -----
+    To be applied to a string date column.
+
+    Parameters
+    ----------
+    col: str
+        a string column that has a date
+
+    Returns
+    -------
+    output_date: date
+        a date column
+    
+    Examples
+    --------
+    ```{python}
+    #| echo: false
+    {{< include "../_setup.qmd" >}}
+    ```
+    ```{python}
+    import polars as pl
+    from src.subtype_link.utils.helpers import date_format
+
+
+    df = pl.DataFrame({
+        "dates": [
+            "2024-10-30",     # ISO format
+            "30/10/2024",     # European format
+            "10/20/2024",     # US format
+            "10-30-2024",     # US format
+            "October 30, 2024",  # Full month name format,
+            "45496",           # an excel date LOL
+            "2022-12-27 08:26:49"
+        ]
+    })
+    
+    print(
+        df
+        .with_columns(
+            new_date=date_format('dates','new_date')
+        )
+    )
+    # add something new
+    
+    ```
+
+    """
+    return pl.coalesce(
+            # see this for date types https://docs.rs/chrono/latest/chrono/format/strftime/index.html
+            # regular dates like sane people yyyy-mm-dd
+            pl.col(col).str.strptime(pl.Date, "%F", strict=False),
+            # datetimes - semi sane
+            pl.col(col).str.strptime(pl.Date, "%F %T", strict=False),
+            # m/d/y - gettin wild
+            pl.col(col).str.strptime(pl.Date, "%D", strict=False),
+            # dont even ask
+            pl.col(col).str.strptime(pl.Date, "%c", strict=False),
+            # mm-dd-yyyy
+            pl.col(col).str.strptime(pl.Date, "%m-%d-%Y", strict=False),
+            # dd-mm-yyyy
+            pl.col(col).str.strptime(pl.Date, "%d-%m-%Y", strict=False),
+            # mm/dd/yyyy
+            pl.col(col).str.strptime(pl.Date, "%m/%d/%Y", strict=False),
+            # dd/mm/yyyy
+            pl.col(col).str.strptime(pl.Date, "%d/%m/%Y", strict=False),
+            # if someone literally writes out the month. smh
+            pl.col(col).str.strptime(pl.Date, "%B %d, %Y", strict=False),
+            # if someone sends an excel date we'll just reject it and call the cops on them
+
+        ).alias(output_date_name)
+        
+
+def save_raw_values(df_inp: pl.DataFrame, primary_key_col: str):
+    """ save raw values
+
+    Usage
+    -----
+    Converts a polars dataframe into a dataframe with all columns in a struct column.
+    It's good for saving raw outputs of data.
+
+    Parameters
+    ----------
+    df_inp: pl.DataFrame
+        a polars dataframe
+    primary_key_col: str
+        column name for the primary key (submission key, not person/case key)
+
+    Returns
+    -------
+    df: pl.DataFrame
+        a dataframe
+    
+    Examples
+    --------
+    ```{python}
+    #| echo: false
+    {{< include "../_setup.qmd" >}}
+    ```
+    ```{python}
+    import polars as pl
+    from test_project import helpers
+
+    data = pl.DataFrame({
+        "lab_name": ["PHL", "MFT", "ELR","PHL"],
+        "first_name": ["Alice", "Bob", "Charlie", "Charlie"],
+        "last_name": ["Smith", "Johnson", "Williams", "Williams"],
+        "WA_ID": [1,2,4,4]
+    })
+    
+    received_submissions_df = (
+            helpers.save_raw_values(df_inp=data,primary_key_col="WA_ID")
+    )
+
+    helpers.gt_style(df_inp=data)
+    
+    ```
+
+    ```{python}
+    helpers.gt_style(df_inp=received_submissions_df)
+    ```
+
+    """
+
+    df = (
+        df_inp
+        .select([
+            # save the primary key
+            pl.col(primary_key_col).alias('submission_number'),
+
+            # internal create date
+            pl.lit(date.today()).alias("internal_create_date"),
+
+            # save a copy of all the original columns and put them into a struct column
+            pl.struct(pl.all()).alias("raw_inbound_submission")
+        ])
+    )
+
+    return df
+
+def func():
+    return print("hi")
+

water_bottle_please-0.6.4.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: water-bottle-please
+Version: 0.6.4
+Summary: Add your description here
+Author: Frank Aragclear
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: polars>=1.24.0
+Description-Content-Type: text/markdown
+
+# test_project
+testing out making a python package
+
+# How to install the package
+
+Open PowerShell terminal (or Ubuntu bash terminal)
+
+1. Make a new folder
+2. `pip install uv`
+3. `uv venv --python 3.11`
+4.  `.\.venv\Scripts\activate`
+5. `uv pip install polars`
+6. `uv pip install git+https://github.com/coe-test-org/test_project.git#egg=test_project`
+
+To install a specific version, find the git tag noted in the GitHub Release section (something like `v0.2.5`) and then put it in the install statement like `.git@v0.2.5`:
+
+```bash
+uv pip install git+https://github.com/coe-test-org/test_project.git@v0.2.5#egg=test_project
+```
+
+here's what it looks like when updating the install version:
+
+![image](https://github.com/user-attachments/assets/ac571054-4918-40a1-b601-000869b97866)
+
+
+
+# How to test it
+create a script called `main.py` in your folder and run this code:
+
+```python
+
+from test_project import helpers
+import polars as pl
+
+
+df = pl.DataFrame({
+    'date': [
+        '2022-01-03',
+        '01-02-2020',
+        '44115',
+        None,
+        "2022-12-27 08:26:49",
+        # "2022-12-27T08:26:49",
+        '01/02/1995',
+        '2/3/2022',
+        '2/16/2022'
+    ]
+})
+
+df_output = (
+    df
+    .with_columns(
+        output_date = helpers.date_format('date')
+    )
+    .select('output_date')
+)
+
+print(df_output)
+```
+
+it should give you this output
+
+```python
+>>> print(df_output)
+shape: (8, 1)
+┌─────────────┐
+│ output_date │
+│ ---         │
+│ date        │
+╞═════════════╡
+│ 2022-01-03  │
+│ 2020-01-02  │
+│ null        │
+│ null        │
+│ 2022-12-27  │
+│ 1995-01-02  │
+│ 2022-02-03  │
+│ 2022-02-16  │
+└─────────────┘
+```
+
+
+# For Devs
+
+## how to create a package with uv
+1. In a new repo, run `uv init --package <package_name>`
+	It gives you this:
+```bash
+.
+├── LICENSE
+├── README.md
+└── test_package
+    ├── README.md
+    ├── pyproject.toml
+    └── src
+        └── test_package
+            └── __init__.py
+
+3 directories, 5 files
+
+```
+2. Create a venv with `uv venv`
+  a. This creates a venv you can activate (called your package name)
+	b. Creates a  `uv.lock` file 
+	c. `Uv sync` to install and update your venv
+3. Run `uv build` and it will build your package, adding a `dist/` folder with a `.tar.gz` file of the package.
+	a. Amazing
+	b. [follow these docs](https://docs.astral.sh/uv/guides/package/#publishing-your-package) to publish it to pypi or somewhere else privately 
+4. To install from github: `uv pip install git+https://github.com/coe-test-org/test_project.git#egg=test_project`
+If you get python version error, add python version to your .venv with `uv python install 3.11` or rebuild the venv with `uv venv --python 3.11`
+
+5. for dev packages that you need but aren't package dependencies, like `pytest`, you can add them to the project with [development dependencies](https://docs.astral.sh/uv/concepts/projects/dependencies/#development-dependencies) like this:
+
+```bash
+uv add --dev pytest
+```
+
+and that will add pytest to the `uv.lock` and `pyproject.toml` but as a separate dependency from the actual packages. In other words, the package won't be dependent on `pytest`, but it will be installed for devs that want to run the unit tests.
+
+## how to build the package automatically with CI/CD
+
+this repo has a github action that automatically runs unit tests, builds the package, and outputs a changelog for a github release.
+
+The github action has two steps:
+
+### 1. unit-tests
+
+This step will install `uv`, install python, and then run the unit tests in the `tests` folder.
+
+```yaml
+unit-tests:
+    name: Build and Test Python Package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.5" # pin a specific version is best practice
+          enable-cache: true
+
+      # install python in 
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Run tests
+        # For example, using `pytest`
+        run: uv run pytest tests
+```
+
+### 2. build-and-release
+
+This step is dependent on the first step above. If any unit-tests fail, then this build/release will not run.
+
+The build step works like this:
+
+1. Scan the code for conventional commit messages (like `fix:`, `feat:`, etc) and render a changelog based on the commits
+2. Create a GitHub Release (git tags) that bump up the version of the codebase (like `v1.0.0` to `v1.1.0`)
+3. Build the python package and have its version match the git tag version. `uv` currently doesn't have a built in way to do this, but [they are currently working on it](https://github.com/astral-sh/uv/issues/6298). In the meantime, that link has a way to link the python package version to the git release like this:
+
+```yaml
+# install uv
+- name: Set up uv
+  run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+- name: Build package
+  if: ${{ steps.changelog.outputs.skipped == 'false' }}
+  run: |
+    VERSION=$(uvx dunamai from any --no-metadata --style pep440) # find the version of the git tag for the python package
+    echo $VERSION
+    uvx --from=toml-cli toml set --toml-path=pyproject.toml project.version $VERSION # update the version in the pyproject.toml
+    uv build # build the package
+
+```
+
+so it will update the `pyproject.toml` to have the most up to date version that matches the git tag version and then build the package with `uv build`. The [build function](https://docs.astral.sh/uv/concepts/projects/build/#using-uv-build) builds the package and outputs a `dist/` folder with a `.tar.gz` file and a `.whl` file, both of which are source files for installing the package.
+
+
+I also wanted to take the `.tar.gz` and `.whl` files and add them to the `Assets` in the changelog for GitHub. That way we can always save copies of our package whenever we make a new release, just to be safe.
+
+```yaml
+# Attach the build assets to the GitHub release (only if changelog creation was successful)
+- name: Upload sdist to GitHub release
+  run: gh release upload $TAG $FILES --clobber
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    TAG: ${{ steps.changelog.outputs.tag }} # this is pulled from the changelog step where it creates the git tag
+    FILES: dist/*.tar.gz dist/*.whl # these files are created in the build step
+```
+
+
+
+
+
+
+
+
+
+

water_bottle_please-0.6.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+water_bottle_please/__init__.py,sha256=bFpDzlDp-dcBXUDHUeeGB0oMwcp2p0i3cb_Tw_wDAEo,58
+water_bottle_please/helpers.py,sha256=jC_XFH4dUDaP77VQepWQGTVyXSFNP2AFJzaK9BrIXWw,4403
+water_bottle_please-0.6.4.dist-info/METADATA,sha256=K30aQ7cwPMcQK4E-9fXqOi6RAy44FG79stgnVdHmJEo,6750
+water_bottle_please-0.6.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+water_bottle_please-0.6.4.dist-info/entry_points.txt,sha256=tZ1un5vxdxvEKvtzDPQdPo_lV0l2nRujESRMuJBlEu0,65
+water_bottle_please-0.6.4.dist-info/licenses/LICENSE,sha256=6_OJwRbyTDHUFt6errQAsS_VA6b7OlMwOBoCqf63cNU,1069
+water_bottle_please-0.6.4.dist-info/RECORD,,

water_bottle_please-0.6.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

water_bottle_please-0.6.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+water-bottle-please = water_bottle_please:main

water_bottle_please-0.6.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 coe-test-org
+
+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.