Metadata-Version: 2.4
Name: opentrash
Version: 0.0.0
Summary: Cloud-native geospatial tools for residential waste operations.
Project-URL: Homepage, https://github.com/OWNER/opentrash
Project-URL: Documentation, https://OWNER.github.io/opentrash/
Project-URL: Repository, https://github.com/OWNER/opentrash
Author: AI Research Corps (AIRC)
License: cat > LICENSE <<'EOF'
        MIT License
        
        Copyright (c) 2026 Mohamad Yassin
        
        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.
        EOF
License-File: LICENSE
Keywords: cloud-native,duckdb,geospatial,gis,routing,waste-management
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == 'docs'
Description-Content-Type: text/markdown

# opentrash

> Cloud-native geospatial tools for residential waste operations.

`opentrash` is an open source Python package for analyzing residential solid
waste collection operations using GPS telematics, enterprise waste-management
data, and municipal parcel layers. It produces **RouteView** — a self-contained
interactive HTML map for any route on any day — and detects per-parcel weekly
and biweekly service **patterns** over time.

The same tools enterprise fleet software sells for six figures, built on open
standards and open data, runnable on a laptop.

## Status

🚧 **Phase 0 — skeleton.** Version `0.0.0` is a name placeholder; the package is
not yet functional. It is being built lesson by lesson alongside its
documentation site and a public course.

## What it will do

- **RouteView** — one route + one day → an interactive HTML map (route polygon,
  GPS trail, landfill tips, parcels served vs missed, tonnage).
- **Patterns** — long GPS history → per-parcel weekly/biweekly service
  signatures, as a portable parquet file RouteView can optionally consume.

## Roadmap

- **RouteEdit** — interactive route-editing tool, sister to RouteView.
- **Sample synthetic data** — redistributable dataset for tutorials.
- **Cloud-hosted demo** — publicly browsable RouteView instance.
- **Hardware integrations** — RFID container reader, vehicle LiDAR.

## Documentation

The documentation site is built with MkDocs Material and deployed to GitHub
Pages. To preview locally:

```bash
pip install mkdocs-material
mkdocs serve
```

## Development

```bash
conda create -n opentrash python=3.11 -y
conda activate opentrash
pip install -e ".[dev,docs]"
```

## License

Source-available under a non-commercial license. See [LICENSE](LICENSE).
Commercial licensing inquiries: contact AIRC.

## About

An open source project under
[AI Research Corps (AIRC)](https://airesearchcorps.org/), a 501(c)(3) nonprofit.
