From de8afa6335c88368929f14c8f376cfa8d49ae5ea Mon Sep 17 00:00:00 2001
From: Alexander Hess <alexander@webartifex.biz>
Date: Mon, 3 Aug 2020 20:19:42 +0200
Subject: [PATCH] Initial commit

- add the following files:
  + .gitignore => ignore poetry's and pyenv's artifacts
  + LICENSE.txt => MIT license as the project is scientific research
  + README.md => rough description of the project
  + poetry.lock
  + pyproject.toml
  + src/urban_meal_delivery/__init__.py => source code package
- use a "src" layout structure:
  + ensure that pytest runs the tests against a packaged and pip
    installed version of the source code, not the *.py files in the
    project directory
  + more info: https://hynek.me/articles/testing-packaging/
---
 .gitignore                          |  3 +++
 LICENSE.txt                         | 19 +++++++++++++++++++
 README.md                           | 16 ++++++++++++++++
 poetry.lock                         |  8 ++++++++
 pyproject.toml                      | 25 +++++++++++++++++++++++++
 src/urban_meal_delivery/__init__.py |  1 +
 6 files changed, 72 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 LICENSE.txt
 create mode 100644 README.md
 create mode 100644 poetry.lock
 create mode 100644 pyproject.toml
 create mode 100644 src/urban_meal_delivery/__init__.py

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..47d1330
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+*.egg-info/
+.python-version
+.venv/
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..1cb438f
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,19 @@
+Copyright (c) 2020 Alexander Hess [alexander@webartifex.biz]
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b671fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Urban Meal Delivery
+
+This repository holds code
+analyzing the data of an undisclosed urban meal delivery platform
+operating in France from January 2016 to January 2017.
+The goal is to
+optimize the platform's delivery process involving independent couriers.
+
+The analysis is structured into three aspects
+that iteratively build on each other.
+
+## Real-time Demand Forecasting
+
+## Predictive Routing
+
+## Shift & Capacity Planning
diff --git a/poetry.lock b/poetry.lock
new file mode 100644
index 0000000..b9e1c09
--- /dev/null
+++ b/poetry.lock
@@ -0,0 +1,8 @@
+package = []
+
+[metadata]
+content-hash = "fafb334cb038533f851c23d0b63254223abf72ce4f02987e7064b0c95566699a"
+lock-version = "1.0"
+python-versions = "^3.8"
+
+[metadata.files]
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..eb24353
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,25 @@
+[build-system]
+build-backend = "poetry.masonry.api"
+requires = ["poetry>=0.12"]
+
+[tool.poetry]
+name = "urban-meal-delivery"
+version = "0.1.0.dev0"
+
+authors = ["Alexander Hess <alexander@webartifex.biz>"]
+description = "Optimizing an urban meal delivery platform"
+keywords = [
+    "data-science",
+    "meal-delivery",
+    "vehicle-routing-problem",
+]
+license = "MIT"
+
+readme = "README.md"
+homepage = "https://github.com/webartifex/urban-meal-delivery"
+repository = "https://github.com/webartifex/urban-meal-delivery"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.dev-dependencies]
diff --git a/src/urban_meal_delivery/__init__.py b/src/urban_meal_delivery/__init__.py
new file mode 100644
index 0000000..27023c3
--- /dev/null
+++ b/src/urban_meal_delivery/__init__.py
@@ -0,0 +1 @@
+"""Source code for the urban-meal-delivery research project."""