From 1d2e5236c5634e55c7a9820398ee47d569c96ee2 Mon Sep 17 00:00:00 2001 From: Sebastian Quintero Date: Wed, 6 Dec 2023 16:34:40 -0500 Subject: [PATCH] Start adding all the Python goodies. Left at completing the Stop --- .github/workflows/python-lint.yml | 21 +++ LICENSE | 201 ++++++++++++++++++++++++++++ nextmv/__init__.py | 4 +- nextmv/hello.py | 2 - nextmv/nextroute/__init__.py | 2 + nextmv/nextroute/schema/location.py | 13 ++ nextmv/nextroute/schema/stop.py | 18 +++ pyproject.toml | 38 ++++++ requirements.txt | 3 + sdk-python.code-workspace | 8 ++ setup.py | 29 ---- {test => tests}/test_hello.py | 0 version.txt | 1 - 13 files changed, 305 insertions(+), 35 deletions(-) create mode 100644 .github/workflows/python-lint.yml create mode 100644 LICENSE delete mode 100644 nextmv/hello.py create mode 100644 nextmv/nextroute/__init__.py create mode 100644 nextmv/nextroute/schema/location.py create mode 100644 nextmv/nextroute/schema/stop.py create mode 100644 pyproject.toml create mode 100644 sdk-python.code-workspace delete mode 100644 setup.py rename {test => tests}/test_hello.py (100%) delete mode 100644 version.txt diff --git a/.github/workflows/python-lint.yml b/.github/workflows/python-lint.yml new file mode 100644 index 0000000..b667148 --- /dev/null +++ b/.github/workflows/python-lint.yml @@ -0,0 +1,21 @@ +name: python lint +on: [push] +jobs: + sdk-python-lint: + runs-on: ubuntu-latest + steps: + - name: git clone + uses: actions/checkout@v3 + + - name: set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.12" + + - name: install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: lint with ruff + run: ruff check --output-format=github . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ad45950 --- /dev/null +++ b/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 2022-2023 nextmv.io inc. + + 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. diff --git a/nextmv/__init__.py b/nextmv/__init__.py index 777bd8c..1d37ac3 100644 --- a/nextmv/__init__.py +++ b/nextmv/__init__.py @@ -1,3 +1 @@ -from .hello import main - -__all__ = [main] +"""Nextmv Python SDK.""" diff --git a/nextmv/hello.py b/nextmv/hello.py deleted file mode 100644 index 855cc7c..0000000 --- a/nextmv/hello.py +++ /dev/null @@ -1,2 +0,0 @@ -def main(): - print("Hello, Python!") diff --git a/nextmv/nextroute/__init__.py b/nextmv/nextroute/__init__.py new file mode 100644 index 0000000..9064253 --- /dev/null +++ b/nextmv/nextroute/__init__.py @@ -0,0 +1,2 @@ +"""Nextroute is a fast and flexible solver for Vehicle Routing Problems +(VRPs).""" diff --git a/nextmv/nextroute/schema/location.py b/nextmv/nextroute/schema/location.py new file mode 100644 index 0000000..8097e2e --- /dev/null +++ b/nextmv/nextroute/schema/location.py @@ -0,0 +1,13 @@ +"""Defines the Location class.""" + +from dataclasses import dataclass + + +@dataclass +class Location: + """Location represents a geographical location.""" + + lon: float + """Longitude of the location.""" + lat: float + """Latitude of the location.""" diff --git a/nextmv/nextroute/schema/stop.py b/nextmv/nextroute/schema/stop.py new file mode 100644 index 0000000..bc01f13 --- /dev/null +++ b/nextmv/nextroute/schema/stop.py @@ -0,0 +1,18 @@ +"""Defines the Stop class.""" +from dataclasses import dataclass +from typing import Any + +from nextmv.nextroute.schema.location import Location + + +@dataclass +class Stop: + """Stop is a location that must be visited by a vehicle in a Vehicle + Routing Problem (VRP.)""" + + id: str + """Unique identifier for the stop.""" + location: Location + """Location of the stop.""" + precedes: Any + """Stops that must be visited after this one on the same route.""" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c8a5093 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,38 @@ +[build-system] +requires = ["hatchling >= 1.13.0"] +build-backend = "hatchling.build" + +[project] +name = "nextmv" +description = "The Python SDK for Nextmv" +readme = "README.md" +requires-python = ">=3.8" +license = {file = "LICENSE"} +authors = [ + { name = "Nextmv", email = "support@nextmv.io" } +] +keywords = ["nextmv", "optimization", "solver", "vehicle routing problem", "operations research", "decisions", "decision engineering"] +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", +] +version = "0.1.0" + +[project.urls] +Homepage = "https://www.nextmv.io" +Documentation = "https://www.nextmv.io/docs" +Repository = "https://github.com/nextmv-io/sdk-python" + +[tool.ruff] +target-version = "py312" +select = [ + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "I", # isort + "C", # flake8-comprehensions + "B", # flake8-bugbear + "UP", # pyupgrade +] +line-length = 120 diff --git a/requirements.txt b/requirements.txt index e69de29..b3485fe 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,3 @@ +ruff==0.1.7 +setuptools==69.0.2 +wheel==0.42.0 diff --git a/sdk-python.code-workspace b/sdk-python.code-workspace new file mode 100644 index 0000000..5709732 --- /dev/null +++ b/sdk-python.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} diff --git a/setup.py b/setup.py deleted file mode 100644 index 337512f..0000000 --- a/setup.py +++ /dev/null @@ -1,29 +0,0 @@ -from os import path -import setuptools - -# Collect additional information from separate files -dir = path.abspath(path.dirname(__file__)) -with open(path.join(dir, "requirements.txt"), encoding="utf-8") as fp: - install_requires = fp.read() -with open(path.join(dir, "version.txt"), encoding="utf-8") as fp: - version = fp.readline().strip() -with open(path.join(dir, "README.md"), encoding="utf-8") as fp: - readme = fp.read() - -# Actual setup -setuptools.setup( - name="nextmv", - description="Nextmv's Python library for solving decision problems", - long_description=readme, - long_description_content_type="text/markdown", - version=version, - author="Nextmv inc.", - author_email="support@nextmv.io", - url="https://github.com/nextmv/sdk-python", - packages=["nextmv"], - install_requires=install_requires, - classifiers=[ - "Programming Language :: Python :: 3", - "Operating System :: OS Independent", - ], -) diff --git a/test/test_hello.py b/tests/test_hello.py similarity index 100% rename from test/test_hello.py rename to tests/test_hello.py diff --git a/version.txt b/version.txt deleted file mode 100644 index 8acdd82..0000000 --- a/version.txt +++ /dev/null @@ -1 +0,0 @@ -0.0.1