| Name | bfb-delivery JSON |
| Version |
0.6.9
JSON |
| download |
| home_page | None |
| Summary | Tools to help plan deliveries for Bellingham Food Bank. |
| upload_time | 2025-03-06 22:42:45 |
| maintainer | None |
| docs_url | None |
| author | Kaleb Coberly |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Bellingham Food Bank delivery planning toolkit
## Summary
This set of command-line tools cuts some cruft around creating delivery route manifests. See the docs: https://crickets-and-comb.github.io/bfb_delivery/.
The plan is to continue to build this package out to take on more of the tasks food-bank staff do manually to plan the delivery routes.
They use Circuit (https://getcircuit.com) to create optimized routes from lists of addresses and products, but there are some tedious tasks to prepare the data for Circuit and then to format the optimized routes into manifests for printing:
0. Put all the stops in a single spreadsheet.
1. Upload stop to Circuit to produce a single huge route as a starting point.
2. Download the optimized route.
3. Manually "chunk" the route by driver (assign stops to drivers according to how many boxes a driver can carry, what is a sensible set of stops, per-driver constraints, etc.).
4. Split those routes into separate worksheets.
5. Upload those smaller routes to Circuit again.
6. Set attributes etc., launch optimization, and distribute to drivers.
7. Download the optimized CSVs.
8. Combine the output CSVs into a single Excel workbook with a worksheet for each route.
9. Finally format the sheets into printable manifests with a combination of Excel macro and manual steps.
Staff spend several hours each week on the manual pieces of this, the chunking (step 3) alone taking about four hours. Now staff need only do the chunking, and step 0 of collecting all the stops, because the `bfb_delivery` package will do the rest.
## Dev plan
We have no intention or desire to replace Circuit. In addition to optimizing routes, Circuit pushes routes to an app drivers can use, etc. But, there are some processes outside of that to further automate/support:
- Chunking by driver (step 3 above): This may be the most challenging piece. I'm only a little confident I can solve this well enough to justify using my solution. So, I have saved it for after I've cleared the low-hanging fruit. My first inclination is to try using a sort of recursive k-nearest neighbors to group stops into potential routes, but that may change once I research existing routing algorithms.
- To that end, implementing a mapping tool to check routes will be helpful in both dev and production.
- There are additional constraints to consider per driver. It may not be possible to encode all of them, but knocking out some of them may help cut down time, and doing this before chunking will better define the problem and add some validations to assist staff.
- DB: There's no plan to develop, host, and support a DB. We're using Excel, CSVs, etc. to keep close to users' knowledge and skill bases, and existing workflow and resources. A DB would be especially useful for encoding driver restrictions etc., but a simple spreadsheet should suffice. If we did start using a DB, however, we'd need to create CRUD interfaces to it.
- GUI: There's no real plan to develop a GUI, but it might be a good portfolio project to try out.
The plan of attack has been to start with the low-hanging fruit of ETL before moving onto the bigger problem of chunking. Fully integrating with the Circuit API is the last step before taking on the chunking, and that is complete. We've putting it into production and will wait and see what arises (bugs, feature requests, etc.) before moving on.
### Frankenstein's "Agile" caveat
The main tool wraps nested tools. This is a natural developmental result of incrementally and tentatively taking over this workflow as a volunteer as I gained trust and access to the org's data, information, and resources. Also, the project was largely unsolicited (but fully approved), so I was hesitant to ask too much of the staff to define and clarify requirements etc.
It hasn't been used yet by staff in production (though certainly tested live), so I haven't yet discovered any of the improvements or mistaken assumptions that real users will likely find. As such, there are some optmizations that could happen to reduce the unnecessary output etc., but I am hesitant to do that until we find what works best for the users.
Plus, a benefit of having these subtools wrapped within the larger tool is that it produces intermediate outputs and maintains backwards compatability that can be rolled back to the old methods for a given step should it fail for some reason, without the need to do the whole process over again.
## Structure
```bash
.github/workflows GitHub Actions CI/CD workflows.
docs RST docs and doc build staging.
Makefile Dev tools and params. (includes shared/Makefile)
setup.cfg Metadata and dependencies.
shared Shared dev tools Git submodule.
src/reference_package/api Public and internal API.
src/reference_package/cli Command-line-interface.
src/reference_package/lib Implementation.
tests/e2e End-to-end tests.
test/integration Integration tests.
tests/unit Unit tests.
```
## Dependencies
* Python 3.11
* [make](https://www.gnu.org/software/make/)
See `setup.cfg` for installation requirements.
## Installation
Run `pip install bfb_delivery`. See https://pypi.org/project/bfb-delivery/.
## Usage Examples
See docs for full usage: https://crickets-and-comb.github.io/bfb_delivery/
### Public API
`bfb_delivery` is a library from which you can import functions. Import the public `build_routes_from_chunked` function like this:
```python
from bfb_delivery import build_routes_from_chunked
# These are okay too:
# from bfb_delivery.api import build_routes_from_chunked
# from bfb_delivery.api.public import build_routes_from_chunked
```
Or, if you're a power user and want any extra options that may exist, you may want to import the internal version like this:
```python
from bfb_delivery.api.internal import build_routes_from_chunked
```
Unless you're developing, avoid importing directly from library:
```python
# Don't do this:
from bfb_delivery.lib.dispatch.write_to_circuit import build_routes_from_chunked
```
### CLI
Try the CLI with this package installed:
$ build_routes_from_chunked --input_path "some/path_to/raw_chunked_sheet.xlsx"
See other options in the help menu:
$ build_routes_from_chunked --help
CLI tools (see docs for more information):
- build_routes_from_chunked
- split_chunked_route
- create_manifests_from_circuit
- create_manifests
- combine_route_tables
- format_combined_routes
## Dev
### Setting up shared tools
There are some shared dev tools in a Git submodule called `shared`. See https://github.com/crickets-and-comb/shared. When you first clone this repo, you need to initialize the submodule:
$ git submodule init
$ git submodule update
See https://git-scm.com/book/en/v2/Git-Tools-Submodules
### Dev installation
You'll want this package's site-package files to be the source files in this repo so you can test your changes without having to reinstall. We've got some tools for that.
First build and activate the env before installing this package:
$ make build-env
$ conda activate bfb_delivery_py3.12
(Note, you will need Python activated, e.g. via conda base env, for `build-env` to work, since it uses Python to grab `PACKAGE_NAME` in the Makefile. You could alternatively just hardcode the name.)
Then, install this package and its dev dependencies:
$ make install
This installs all the dependencies in your conda env site-packages, but the files for this package's installation are now your source files in this repo.
### Dev workflow
You can list all the make tools you might want to use:
$ make list-targets
Go check them out in `Makefile`.
#### QC and testing
Before pushing commits, you'll usually want to rebuild the env and run all the QC and testing:
$ make clean full
When making smaller commits, you might just want to run some of the smaller commands:
$ make clean format full-qc full-test
#### CI test run
Before opening a PR or pushing to it, you'll want to run locally the same CI pipeline that GitHub will run (`.github/workflows/CI_CD.yml`). This runs on multiple images, so you'll need to install Docker and have it running on your machine: https://www.docker.com/
Once that's installed and running, you can use `act`. You'll need to install that as well. I develop on a Mac, so I used `homebrew` to install it (which you'll also need to install: https://brew.sh/):
$ brew install act
Then, run it from the repo directory:
$ make run-act
That will run `.github/workflows/CI_CD.yml` and every other action tagged to the pull_request event. Also, since `act` doesn't work with Mac and Windows architecture, it skips/fails them, but it is a good test of the Linux build.
## Acknowledgments
This package is made from the `reference_package` template repo: https://github.com/crickets-and-comb/reference_package.
Raw data
{
"_id": null,
"home_page": null,
"name": "bfb-delivery",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "kaleb.coberly@gmail.com",
"keywords": null,
"author": "Kaleb Coberly",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e2/de/827acc22194c430ea1a1899ed6fbba5b10b17f529db695a7109d423f02bb/bfb_delivery-0.6.9.tar.gz",
"platform": null,
"description": "# Bellingham Food Bank delivery planning toolkit\n\n## Summary\n\nThis set of command-line tools cuts some cruft around creating delivery route manifests. See the docs: https://crickets-and-comb.github.io/bfb_delivery/.\n\nThe plan is to continue to build this package out to take on more of the tasks food-bank staff do manually to plan the delivery routes.\n\nThey use Circuit (https://getcircuit.com) to create optimized routes from lists of addresses and products, but there are some tedious tasks to prepare the data for Circuit and then to format the optimized routes into manifests for printing:\n\n0. Put all the stops in a single spreadsheet.\n1. Upload stop to Circuit to produce a single huge route as a starting point.\n2. Download the optimized route.\n3. Manually \"chunk\" the route by driver (assign stops to drivers according to how many boxes a driver can carry, what is a sensible set of stops, per-driver constraints, etc.).\n4. Split those routes into separate worksheets.\n5. Upload those smaller routes to Circuit again.\n6. Set attributes etc., launch optimization, and distribute to drivers.\n7. Download the optimized CSVs.\n8. Combine the output CSVs into a single Excel workbook with a worksheet for each route.\n9. Finally format the sheets into printable manifests with a combination of Excel macro and manual steps.\n\nStaff spend several hours each week on the manual pieces of this, the chunking (step 3) alone taking about four hours. Now staff need only do the chunking, and step 0 of collecting all the stops, because the `bfb_delivery` package will do the rest.\n\n## Dev plan\n\nWe have no intention or desire to replace Circuit. In addition to optimizing routes, Circuit pushes routes to an app drivers can use, etc. But, there are some processes outside of that to further automate/support:\n\n- Chunking by driver (step 3 above): This may be the most challenging piece. I'm only a little confident I can solve this well enough to justify using my solution. So, I have saved it for after I've cleared the low-hanging fruit. My first inclination is to try using a sort of recursive k-nearest neighbors to group stops into potential routes, but that may change once I research existing routing algorithms.\n\n- To that end, implementing a mapping tool to check routes will be helpful in both dev and production.\n\n- There are additional constraints to consider per driver. It may not be possible to encode all of them, but knocking out some of them may help cut down time, and doing this before chunking will better define the problem and add some validations to assist staff.\n\n- DB: There's no plan to develop, host, and support a DB. We're using Excel, CSVs, etc. to keep close to users' knowledge and skill bases, and existing workflow and resources. A DB would be especially useful for encoding driver restrictions etc., but a simple spreadsheet should suffice. If we did start using a DB, however, we'd need to create CRUD interfaces to it.\n\n- GUI: There's no real plan to develop a GUI, but it might be a good portfolio project to try out.\n\nThe plan of attack has been to start with the low-hanging fruit of ETL before moving onto the bigger problem of chunking. Fully integrating with the Circuit API is the last step before taking on the chunking, and that is complete. We've putting it into production and will wait and see what arises (bugs, feature requests, etc.) before moving on.\n\n### Frankenstein's \"Agile\" caveat\n\nThe main tool wraps nested tools. This is a natural developmental result of incrementally and tentatively taking over this workflow as a volunteer as I gained trust and access to the org's data, information, and resources. Also, the project was largely unsolicited (but fully approved), so I was hesitant to ask too much of the staff to define and clarify requirements etc.\n\nIt hasn't been used yet by staff in production (though certainly tested live), so I haven't yet discovered any of the improvements or mistaken assumptions that real users will likely find. As such, there are some optmizations that could happen to reduce the unnecessary output etc., but I am hesitant to do that until we find what works best for the users.\n\nPlus, a benefit of having these subtools wrapped within the larger tool is that it produces intermediate outputs and maintains backwards compatability that can be rolled back to the old methods for a given step should it fail for some reason, without the need to do the whole process over again.\n\n## Structure\n\n```bash\n .github/workflows GitHub Actions CI/CD workflows.\n docs RST docs and doc build staging.\n Makefile Dev tools and params. (includes shared/Makefile)\n setup.cfg Metadata and dependencies.\n shared Shared dev tools Git submodule.\n src/reference_package/api Public and internal API.\n src/reference_package/cli Command-line-interface.\n src/reference_package/lib Implementation.\n tests/e2e End-to-end tests.\n test/integration Integration tests.\n tests/unit Unit tests.\n```\n\n## Dependencies\n\n* Python 3.11\n* [make](https://www.gnu.org/software/make/)\n\nSee `setup.cfg` for installation requirements.\n\n## Installation\n\nRun `pip install bfb_delivery`. See https://pypi.org/project/bfb-delivery/.\n\n## Usage Examples\n\nSee docs for full usage: https://crickets-and-comb.github.io/bfb_delivery/\n\n### Public API\n\n`bfb_delivery` is a library from which you can import functions. Import the public `build_routes_from_chunked` function like this:\n\n```python\n from bfb_delivery import build_routes_from_chunked\n # These are okay too:\n # from bfb_delivery.api import build_routes_from_chunked\n # from bfb_delivery.api.public import build_routes_from_chunked\n```\n\nOr, if you're a power user and want any extra options that may exist, you may want to import the internal version like this:\n\n```python\n from bfb_delivery.api.internal import build_routes_from_chunked\n```\n\nUnless you're developing, avoid importing directly from library:\n\n```python\n # Don't do this:\n from bfb_delivery.lib.dispatch.write_to_circuit import build_routes_from_chunked\n```\n\n### CLI\n\nTry the CLI with this package installed:\n\n $ build_routes_from_chunked --input_path \"some/path_to/raw_chunked_sheet.xlsx\"\n\nSee other options in the help menu:\n\n $ build_routes_from_chunked --help\n\nCLI tools (see docs for more information):\n\n- build_routes_from_chunked\n- split_chunked_route\n- create_manifests_from_circuit\n- create_manifests\n- combine_route_tables\n- format_combined_routes\n\n\n## Dev\n\n### Setting up shared tools\n\nThere are some shared dev tools in a Git submodule called `shared`. See https://github.com/crickets-and-comb/shared. When you first clone this repo, you need to initialize the submodule:\n\n $ git submodule init\n $ git submodule update\n\nSee https://git-scm.com/book/en/v2/Git-Tools-Submodules\n\n### Dev installation\n\nYou'll want this package's site-package files to be the source files in this repo so you can test your changes without having to reinstall. We've got some tools for that.\n\nFirst build and activate the env before installing this package:\n\n $ make build-env\n $ conda activate bfb_delivery_py3.12\n\n(Note, you will need Python activated, e.g. via conda base env, for `build-env` to work, since it uses Python to grab `PACKAGE_NAME` in the Makefile. You could alternatively just hardcode the name.)\n\nThen, install this package and its dev dependencies:\n\n $ make install\n\nThis installs all the dependencies in your conda env site-packages, but the files for this package's installation are now your source files in this repo.\n\n### Dev workflow\n\nYou can list all the make tools you might want to use:\n\n $ make list-targets\n\nGo check them out in `Makefile`.\n\n#### QC and testing\n\nBefore pushing commits, you'll usually want to rebuild the env and run all the QC and testing:\n\n $ make clean full\n\nWhen making smaller commits, you might just want to run some of the smaller commands:\n\n $ make clean format full-qc full-test\n\n#### CI test run\n\nBefore opening a PR or pushing to it, you'll want to run locally the same CI pipeline that GitHub will run (`.github/workflows/CI_CD.yml`). This runs on multiple images, so you'll need to install Docker and have it running on your machine: https://www.docker.com/\n\nOnce that's installed and running, you can use `act`. You'll need to install that as well. I develop on a Mac, so I used `homebrew` to install it (which you'll also need to install: https://brew.sh/):\n\n $ brew install act\n\nThen, run it from the repo directory:\n\n $ make run-act\n\nThat will run `.github/workflows/CI_CD.yml` and every other action tagged to the pull_request event. Also, since `act` doesn't work with Mac and Windows architecture, it skips/fails them, but it is a good test of the Linux build.\n\n## Acknowledgments\n\nThis package is made from the `reference_package` template repo: https://github.com/crickets-and-comb/reference_package.\n",
"bugtrack_url": null,
"license": null,
"summary": "Tools to help plan deliveries for Bellingham Food Bank.",
"version": "0.6.9",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c703a2addc6b406f679a2e24623c1e7e29ddea0871bf8374f35e334cf80dae49",
"md5": "f8b5556b01e50804e8e7b004ecd4c372",
"sha256": "7ae533127f44b6b2af7a421f8ced2ff0bf9f658b41e0e91ce6ba8632bc475d79"
},
"downloads": -1,
"filename": "bfb_delivery-0.6.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8b5556b01e50804e8e7b004ecd4c372",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 57615,
"upload_time": "2025-03-06T22:42:43",
"upload_time_iso_8601": "2025-03-06T22:42:43.006504Z",
"url": "https://files.pythonhosted.org/packages/c7/03/a2addc6b406f679a2e24623c1e7e29ddea0871bf8374f35e334cf80dae49/bfb_delivery-0.6.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e2de827acc22194c430ea1a1899ed6fbba5b10b17f529db695a7109d423f02bb",
"md5": "c6320e9e0ad087e8497a94fb4801e6bc",
"sha256": "e0c2b4c34aa8e65a85cabdab3e76eb4852274a265018fbe760db6334e2ed30a7"
},
"downloads": -1,
"filename": "bfb_delivery-0.6.9.tar.gz",
"has_sig": false,
"md5_digest": "c6320e9e0ad087e8497a94fb4801e6bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 50727,
"upload_time": "2025-03-06T22:42:45",
"upload_time_iso_8601": "2025-03-06T22:42:45.196054Z",
"url": "https://files.pythonhosted.org/packages/e2/de/827acc22194c430ea1a1899ed6fbba5b10b17f529db695a7109d423f02bb/bfb_delivery-0.6.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-06 22:42:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bfb-delivery"
}
