dkais 0.1.0__tar.gz

dkais-0.1.0/.gitignore

@@ -0,0 +1,46 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+
+# uv — virtual environment
+.venv/
+.uv-cache/
+
+# hatchling — build output
+dist/
+src/*.egg-info/
+
+# pytest — test cache
+.pytest_cache/
+
+# Coverage.py — reports and data
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# mypy — type-check cache
+.mypy_cache/
+
+# Ruff — lint/format cache
+.ruff_cache/
+
+# prek — pre-commit hook cache
+.prek/
+
+# macOS — filesystem metadata
+.DS_Store
+
+# Windows — filesystem metadata
+Thumbs.db
+ehthumbs.db
+
+# VSCode - settings
+.vscode/
+
+# skill-creator — eval workspaces
+.claude/skills/*-workspace/
+
+.mcp.json
+
+.env*

dkais-0.1.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+<!-- pyml disable MD024 -->
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+> [!NOTE]
+>
+> - `[SemVer] - yyyy-mm-dd` or `[Unreleased]` for release heading.
+> - `Added` for new features.
+> - `Changed` for changes in existing functionality.
+> - `Deprecated` for soon-to-be removed features.
+> - `Removed` for now removed features.
+> - `Fixed` for any bug fixes.
+> - `Security` in case of vulnerabilities.
+
+## [0.1.0] - 2026-10-25
+
+### Added
+
+- [pkgdx](https://gitlab.com/andyrids/pkgdx) canonical standards management.
+- CI/CD pipeline for linting, testing & release.
+- Standards & guidelines documentation in `docs/`
+- `dkais list` command to catalogue bucket archives & local state (`--json`).
+- `dkais download` command for concurrent boto3 downloads with Rich progress.
+- `dkais process` command converting all CSV dialects to `YEAR=/MONTH=` Parquet.
+- `dkais process` extracts one day ahead, in memory when RAM allows, with zlib-ng.
+- `scripts/` profiling & benchmark tools for `dkais process`.
+
+### Changed
+
+- `download`/`process` output is minimal on a terminal (one transient progress line,
+  `warning:`/`error:` messages, one summary), plain lines when not a terminal.
+- Expected failures print one line; tracebacks & verbose logs only with `--debug`.
+- Summaries go to STDOUT, as a `key=value` line when STDOUT is not a terminal.
+- `list` warns when no data directory is set instead of silently omitting local state.
+
+### Fixed
+
+- Redirected output no longer crashes on non-ASCII glyphs under Windows cp1252.
+- `dkais download --jobs` rejects values below 1 with a usage error.
+- `dkais.__version__` falls back to `0.0.0+unknown` when package metadata is unavailable.

dkais-0.1.0/COPYRIGHT

@@ -0,0 +1,15 @@
+Copyright 2026 Andrew Ridyard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0

dkais-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dkais-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.5
+Name: dkais
+Version: 0.1.0
+Summary: CLI for accessing historical AIS data maintained by the Danish Maritime Authority.
+Project-URL: Changelog, https://github.com/andyrids/dkais/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/andyrids/dkais/blob/main/README.md
+Project-URL: Issues, https://github.com/andyrids/dkais/issues
+Project-URL: Repository, https://github.com/andyrids/dkais
+Author-email: Andrew Ridyard <andyrids.culprit320@passmail.com>
+Maintainer-email: Andrew Ridyard <andyrids.culprit320@passmail.com>
+License-Expression: Apache-2.0
+License-File: COPYRIGHT
+License-File: LICENSE
+Keywords: AIS,DMA,IMO,MMSI,maritime,ship,trajectory
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: boto3>=1.43.117
+Requires-Dist: polars>=2.0.0
+Requires-Dist: psutil>=7.2.2
+Requires-Dist: rich
+Requires-Dist: zlib-ng>=1.0.0; python_full_version < '3.14' or sys_platform != 'win32'
+Description-Content-Type: text/markdown
+
+# DK AIS [`dkais`]
+
+This Python package streamlines the download and processing of historical Automatic
+Identification System (AIS) data provided by the Danish Maritime Authority (DMA).
+
+AIS is a maritime navigation safety communications system standardised by the International
+Telecommunication Union (ITU) and adopted by the International Maritime Organization (IMO). AIS is
+a VHF-based navigation and anti-collision tool making it possible to exchange information between
+ships.
+
+For more information about AIS, including its history, functionality and applications - see [Wikipedia](https://en.wikipedia.org/wiki/Automatic_identification_system).
+
+<!-- pyml disable MD034 -->
+https://github.com/user-attachments/assets/b809ad7f-fca4-404a-9a1e-20e29a72d7e8
+<!-- pyml enable MD034 -->
+
+## Usage
+
+`dkais` mirrors the public bucket to a data directory and converts each daily CSV to Parquet.
+Set the directory once with `DKAIS_DATA_DIR` (or pass `--data-dir` to any command).
+
+```sh
+dkais list --start 2026-10                       # archives & local state
+dkais download --start 2026-10 --end 2026-10-07  # zips to <data-dir>/raw
+dkais process --start 2026-10 --end 2026-10-07   # to <data-dir>/parquet
+```
+
+`list --json` emits machine-readable output, `download -j N` sets concurrent downloads (default 4)
+and `process --force` re-converts days that already have Parquet output.
+
+Dates are `YYYY`, `YYYY-MM` or `YYYY-MM-DD` and inclusive. `download` and `process` need `--start`
+or `--all` - the full bucket is ~4.2 TB compressed. `download` fetches whole archives (monthly up to
+2024-02, daily since), while `process` converts only the days in range. Both skip completed work,
+so an interrupted run resumes where it stopped. `process` works offline from `<data-dir>/raw`.
+
+```text
+<data-dir>/
+  raw/YYYY/aisdk-YYYY-MM[-DD].zip
+  parquet/YEAR=2026/MONTH=10/aisdk-2026-10-18.parquet
+  tmp/
+```
+
+> [!NOTE]
+> The `tmp/` directory is used for extracted CSVs when RAM is short.
+
+`process` unzips the next day while converting the current one. A day's CSV is held in memory when
+five times its size is available (a 3 GB daily CSV needs ~15 GB), otherwise it is extracted to
+`<data-dir>/tmp`. Unzipping uses zlib-ng, either from the `zlib-ng` package or the standard
+library where it is built in (CPython 3.14+ on Windows).
+
+Each Parquet file holds one day: all 26 DMA columns renamed to `UPPER_SNAKE` and typed, sorted by
+`MMSI` and `DATETIME`. AIS "not available" values (latitude 91, longitude 181, heading 511,
+`Unknown` IMO/callsign/destination) become null, and no rows are dropped. The three historical CSV
+dialects (comma with 22 columns, header-less semicolon with decimal commas, comma with 26 columns)
+share one output schema.
+
+> [!TIP]
+> See [Features](#features) for a the full schema table and data types.
+
+```python
+import polars as pl
+
+ais = pl.scan_parquet("<data-dir>/parquet", hive_partitioning=True)
+october = ais.filter(pl.col("YEAR") == 2026, pl.col("MONTH") == 10)
+```
+
+## Dataset
+
+- [DMA website](https://www.dma.dk/safety-at-sea/navigational-information/ais-data)
+- [AIS S3](http://aisdata.ais.dk/)
+
+### Metadata
+
+- **Identifiers** - ship name, call sign or IMO number & MMSI number
+- **Navigation** - position, course & speed
+- **Voyage** - destination, ETA & actual draught
+
+### Veracity
+
+Information received by AIS originates from the ships' own instruments. There can be errors in the
+information inserted or technical defects that may give an erroneous impression of the ship's speed
+or position.
+
+AIS contributes to safety of navigation and has, in many ways, made it easier to navigate safely.
+However, AIS also has some limitations that it is important to take account of. If you trust your
+AIS data uncritically, it may be risky.
+
+### Features
+
+See the table below, for the original DMA dataset features and the new feature names in the
+typed Parquet files after `dkais` processing.
+
+<!-- pyml disable MD013 -->
+| Original                        | Processed        | Type          | Comment |
+| ------------------------------- | ---------------- | ------------- | ------- |
+| Timestamp | DATETIME | datetime[μs]  | dd/mm/yyyy HH:MM:SS |
+| Type of mobile | MOBILE_TYPE | cat | Vessel class |
+| MMSI | MMSI | i32 | Maritime Mobile Service Identity (unique 9-digit number) |
+| Latitude | LATITUDE | f64 | Decimal degrees, null if 91 (not available) |
+| Longitude | LONGITUDE | f64 | Decimal degrees, null if 181 (not available) |
+| Navigational Status | NAV_STATUS | cat | Navigational status (AIS metadata) |
+| ROT | ROT | f32 | Rate of Turn (AIS metadata) |
+| SOG | SOG | f32 | Speed Over Ground (AIS metadata) |
+| COG | COG | f32 | Course Over Ground (AIS metadata) |
+| Heading | HEADING | i16 | Heading (AIS metadata), null if 511 (not available) |
+| IMO | IMO | i32 | International Maritime Organization number, null if `Unknown`  |
+| Callsign | CALLSIGN | str | Callsign of the vessel, null if `Unknown` |
+| Name | NAME | str | Name of the vessel |
+| Ship type | SHIP_TYPE | cat | Type of ship (AIS metadata) |
+| Cargo type | CARGO_TYPE | cat | Type of cargo (AIS metadata) |
+| Width | WIDTH | i16 | Width of the vessel |
+| Length | LENGTH | i16 | Length of the vessel |
+| Type of position fixing device | POSITION_DEVICE | cat | e.g. GPS, GLONASS, Galileo, Surveyed |
+| Draught | DRAUGHT | f32 | Draught of the vessel (AIS metadata) |
+| Destination | DESTINATION | str | Destination of the vessel (AIS metadata), null if `Unknown` |
+| ETA | ETA | datetime[μs] | Estimated Time of Arrival, dd/mm/yyyy HH:MM:SS |
+| Data source type | DATA_SOURCE | cat | e.g. AIS |
+| A | SIZE_A | i16 | Length from GPS to the bow, null in 22-column files |
+| B | SIZE_B | i16 | Length from GPS to the stern, null in 22-column files |
+| C | SIZE_C | i16 | Length from GPS to starboard side, null in 22-column files |
+| D | SIZE_D | i16 | Length from GPS to port side, null in 22-column files |
+<!-- pyml enable MD013 -->

dkais-0.1.0/README.md

@@ -0,0 +1,122 @@
+# DK AIS [`dkais`]
+
+This Python package streamlines the download and processing of historical Automatic
+Identification System (AIS) data provided by the Danish Maritime Authority (DMA).
+
+AIS is a maritime navigation safety communications system standardised by the International
+Telecommunication Union (ITU) and adopted by the International Maritime Organization (IMO). AIS is
+a VHF-based navigation and anti-collision tool making it possible to exchange information between
+ships.
+
+For more information about AIS, including its history, functionality and applications - see [Wikipedia](https://en.wikipedia.org/wiki/Automatic_identification_system).
+
+<!-- pyml disable MD034 -->
+https://github.com/user-attachments/assets/b809ad7f-fca4-404a-9a1e-20e29a72d7e8
+<!-- pyml enable MD034 -->
+
+## Usage
+
+`dkais` mirrors the public bucket to a data directory and converts each daily CSV to Parquet.
+Set the directory once with `DKAIS_DATA_DIR` (or pass `--data-dir` to any command).
+
+```sh
+dkais list --start 2026-10                       # archives & local state
+dkais download --start 2026-10 --end 2026-10-07  # zips to <data-dir>/raw
+dkais process --start 2026-10 --end 2026-10-07   # to <data-dir>/parquet
+```
+
+`list --json` emits machine-readable output, `download -j N` sets concurrent downloads (default 4)
+and `process --force` re-converts days that already have Parquet output.
+
+Dates are `YYYY`, `YYYY-MM` or `YYYY-MM-DD` and inclusive. `download` and `process` need `--start`
+or `--all` - the full bucket is ~4.2 TB compressed. `download` fetches whole archives (monthly up to
+2024-02, daily since), while `process` converts only the days in range. Both skip completed work,
+so an interrupted run resumes where it stopped. `process` works offline from `<data-dir>/raw`.
+
+```text
+<data-dir>/
+  raw/YYYY/aisdk-YYYY-MM[-DD].zip
+  parquet/YEAR=2026/MONTH=10/aisdk-2026-10-18.parquet
+  tmp/
+```
+
+> [!NOTE]
+> The `tmp/` directory is used for extracted CSVs when RAM is short.
+
+`process` unzips the next day while converting the current one. A day's CSV is held in memory when
+five times its size is available (a 3 GB daily CSV needs ~15 GB), otherwise it is extracted to
+`<data-dir>/tmp`. Unzipping uses zlib-ng, either from the `zlib-ng` package or the standard
+library where it is built in (CPython 3.14+ on Windows).
+
+Each Parquet file holds one day: all 26 DMA columns renamed to `UPPER_SNAKE` and typed, sorted by
+`MMSI` and `DATETIME`. AIS "not available" values (latitude 91, longitude 181, heading 511,
+`Unknown` IMO/callsign/destination) become null, and no rows are dropped. The three historical CSV
+dialects (comma with 22 columns, header-less semicolon with decimal commas, comma with 26 columns)
+share one output schema.
+
+> [!TIP]
+> See [Features](#features) for a the full schema table and data types.
+
+```python
+import polars as pl
+
+ais = pl.scan_parquet("<data-dir>/parquet", hive_partitioning=True)
+october = ais.filter(pl.col("YEAR") == 2026, pl.col("MONTH") == 10)
+```
+
+## Dataset
+
+- [DMA website](https://www.dma.dk/safety-at-sea/navigational-information/ais-data)
+- [AIS S3](http://aisdata.ais.dk/)
+
+### Metadata
+
+- **Identifiers** - ship name, call sign or IMO number & MMSI number
+- **Navigation** - position, course & speed
+- **Voyage** - destination, ETA & actual draught
+
+### Veracity
+
+Information received by AIS originates from the ships' own instruments. There can be errors in the
+information inserted or technical defects that may give an erroneous impression of the ship's speed
+or position.
+
+AIS contributes to safety of navigation and has, in many ways, made it easier to navigate safely.
+However, AIS also has some limitations that it is important to take account of. If you trust your
+AIS data uncritically, it may be risky.
+
+### Features
+
+See the table below, for the original DMA dataset features and the new feature names in the
+typed Parquet files after `dkais` processing.
+
+<!-- pyml disable MD013 -->
+| Original                        | Processed        | Type          | Comment |
+| ------------------------------- | ---------------- | ------------- | ------- |
+| Timestamp | DATETIME | datetime[μs]  | dd/mm/yyyy HH:MM:SS |
+| Type of mobile | MOBILE_TYPE | cat | Vessel class |
+| MMSI | MMSI | i32 | Maritime Mobile Service Identity (unique 9-digit number) |
+| Latitude | LATITUDE | f64 | Decimal degrees, null if 91 (not available) |
+| Longitude | LONGITUDE | f64 | Decimal degrees, null if 181 (not available) |
+| Navigational Status | NAV_STATUS | cat | Navigational status (AIS metadata) |
+| ROT | ROT | f32 | Rate of Turn (AIS metadata) |
+| SOG | SOG | f32 | Speed Over Ground (AIS metadata) |
+| COG | COG | f32 | Course Over Ground (AIS metadata) |
+| Heading | HEADING | i16 | Heading (AIS metadata), null if 511 (not available) |
+| IMO | IMO | i32 | International Maritime Organization number, null if `Unknown`  |
+| Callsign | CALLSIGN | str | Callsign of the vessel, null if `Unknown` |
+| Name | NAME | str | Name of the vessel |
+| Ship type | SHIP_TYPE | cat | Type of ship (AIS metadata) |
+| Cargo type | CARGO_TYPE | cat | Type of cargo (AIS metadata) |
+| Width | WIDTH | i16 | Width of the vessel |
+| Length | LENGTH | i16 | Length of the vessel |
+| Type of position fixing device | POSITION_DEVICE | cat | e.g. GPS, GLONASS, Galileo, Surveyed |
+| Draught | DRAUGHT | f32 | Draught of the vessel (AIS metadata) |
+| Destination | DESTINATION | str | Destination of the vessel (AIS metadata), null if `Unknown` |
+| ETA | ETA | datetime[μs] | Estimated Time of Arrival, dd/mm/yyyy HH:MM:SS |
+| Data source type | DATA_SOURCE | cat | e.g. AIS |
+| A | SIZE_A | i16 | Length from GPS to the bow, null in 22-column files |
+| B | SIZE_B | i16 | Length from GPS to the stern, null in 22-column files |
+| C | SIZE_C | i16 | Length from GPS to starboard side, null in 22-column files |
+| D | SIZE_D | i16 | Length from GPS to port side, null in 22-column files |
+<!-- pyml enable MD013 -->

dkais-0.1.0/pyproject.toml

@@ -0,0 +1,88 @@
+[project]
+name = "dkais"
+dynamic = ["version"]
+description = "CLI for accessing historical AIS data maintained by the Danish Maritime Authority."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*", "COPYRIGHT"]
+authors = [{ name = "Andrew Ridyard", email = "andyrids.culprit320@passmail.com" }]
+maintainers = [{ name = "Andrew Ridyard", email = "andyrids.culprit320@passmail.com" }]
+requires-python = ">=3.11"
+keywords = ["AIS", "MMSI", "IMO", "maritime", "DMA", "trajectory", "ship"]
+classifiers = [
+    # 3 - Alpha | 4 - Beta | 5 - Production/Stable
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+dependencies = [
+    "boto3>=1.43.117",
+    "polars>=2.0.0",
+    "psutil>=7.2.2",
+    "rich",
+    "zlib-ng>=1.0.0 ; python_full_version < '3.14' or sys_platform != 'win32'",
+]
+
+[dependency-groups]
+dev = [
+    "pkgdx",
+    "coverage",
+    "pytest",
+    "pymarkdownlnt",
+    "boto3-stubs[s3]>=1.43.116",
+    "types-psutil>=7.2.2.20260906",
+]
+
+[project.scripts]
+dkais = "dkais.__main__:main"
+
+[project.urls]
+Changelog = "https://github.com/andyrids/dkais/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/andyrids/dkais/blob/main/README.md"
+Issues = "https://github.com/andyrids/dkais/issues"
+Repository = "https://github.com/andyrids/dkais"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.coverage.run]
+omit = ["tests/*", "*/src_test*/*"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+# lets SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PKGDX work under hatch-vcs
+dist_name = "dkais"
+local_scheme = "no-local-version"
+version_scheme = "guess-next-dev"
+
+[tool.hatch.build.targets.sdist]
+include = ["/src", "/README.md", "/CHANGELOG.md"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dkais"]
+
+[tool.pytest.ini_options]
+addopts = ["--import-mode=importlib"]
+log_cli = true
+log_cli_level = "INFO"
+tmp_path_retention_policy = "failed"
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true, tags = true } }]
+
+[[tool.uv.index]]
+name = "gitlab"
+url = "https://gitlab.com/api/v4/projects/82928123/packages/pypi/simple"
+explicit = true
+
+[tool.uv.sources]
+pkgdx = { index = "gitlab" }