alexander/urban-meal-delivery
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions
urban-meal-delivery/pyproject.toml

96 lines
2.3 KiB
TOML
Raw Normal View History

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/
2020-08-03 20:19:42 +02:00
[build-system]
build-backend = "poetry.masonry.api"
requires = ["poetry>=0.12"]
Add a code formatting tool chain - (auto-)format code with: + autoflake => * remove unused imports and variables * remove duplicate dict keys * expand star imports + black => enforce an uncompromising code style + isort => enforce a consistent import style (complying with Google's Python Style Guide) - implement the nox session "format" that runs all these tools - add the following file: + setup.cfg => holds configurations for the develop tools
2020-08-03 21:39:49 +02:00
[tool.black]
line-length = 88
Add a code linting tool chain - use flake8 as the main and pylint as the auxiliary linter - install flake8 with the following plug-ins: + flake8-annotations => enforce type annotations for functions/classes + flake8-black => ensure black would not make any changes + flake8-expression-complexity + wemake-python-styleguide, which packages the following: * darglint * flake8-bandit * flake8-broken-line * flake8-bugbear * flake8-commas * flake8-comprehensions * flake8-debugger * flake8-docstrings * flake8-eradicate * flake8-isort * flake8-rst-docstrings * flake8-string-format * flake8-quotes * pep8-naming - configure flake8 & friends in a rather explicit and strict way - isort needed to be downgraded to ^4.3.21 due to a conflict with pylint and wemake-python-styleguide: + provide TODO's to remove the parts that "fix" isort - use mypy for static type checking - add a nox session "lint" that runs flake8, mypy, and pylint - lint all source files
2020-08-03 22:41:37 +02:00
skip-string-normalization = true # wemake-python-styleguide enforces single quotes
Add a code formatting tool chain - (auto-)format code with: + autoflake => * remove unused imports and variables * remove duplicate dict keys * expand star imports + black => enforce an uncompromising code style + isort => enforce a consistent import style (complying with Google's Python Style Guide) - implement the nox session "format" that runs all these tools - add the following file: + setup.cfg => holds configurations for the develop tools
2020-08-03 21:39:49 +02:00
target-version = ["py38"]
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/
2020-08-03 20:19:42 +02:00
[tool.poetry]
name = "urban-meal-delivery"
Finalize release 0.4.0
2021-09-13 11:14:17 +02:00
version = "0.4.0"
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/
2020-08-03 20:19:42 +02:00
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"
Add Jupyter Lab environment - dependencies used to run the Jupyter Lab environment that are not required by the `urban-meal-delivery` package itself are put into an installation extra called "research" - this allows to NOT install the requirements, for example, when testing the package in an isolated environment
2020-08-11 10:50:29 +02:00
# Package => code developed in *.py files and packaged under src/urban_meal_delivery
Add shapely to the dependencies
2020-12-30 17:37:51 +01:00
Shapely = "^1.7.1"
Add database migrations - use Alembic to migrate the PostgreSQL database + create initial migration script to set up the database, as an alternative to db.Base.metadata.create_all() + integrate Alembic into the test suite; the db_engine fixture now has two modes: * create the latest version of tables all at once * invoke `alembic upgrade head` => the "e2e" tests are all run twice, once in each mode; this ensures that the migration scripts re-create the same database schema as db.Base.metadata.create_all() would * in both modes, a temporary PostgreSQL schema is used to create the tables in => could now run "e2e" tests against production database and still have isolation - make the configuration module public (to be used by Alembic) - adjust linting rules for Alembic
2020-08-09 17:14:23 +02:00
alembic = "^1.4.2"
Add CLI entry point `umd` - add the following file: + src/urban_meal_delivery/console.py => click-based CLI tools + tests/test_console.py => tests for the module above - add a CLI entry point `umd`: + implement the --version / -V option to show the installed package's version + rework to package's top-level: * add a __pkg_name__ variable to parameterize the package name + add unit and integration tests - fix that pylint cannot know the proper order of imports in the isolated nox session
2020-08-04 21:14:40 +02:00
click = "^7.1.2"
Add folium to the dependencies
2021-01-21 11:47:22 +01:00
folium = "^0.12.1"
Add geopy to the dependencies
2021-03-02 14:33:26 +01:00
geopy = "^2.1.0"
Add googlemaps to the dependencies
2021-03-01 16:00:38 +01:00
googlemaps = "^4.4.2"
Add matplotlib to the dependencies
2021-01-21 17:15:39 +01:00
matplotlib = "^3.3.3"
Add ordered-set to the dependencies
2021-03-02 18:02:42 +01:00
ordered-set = "^4.0.2"
Add `aggregate_orders()` function - the function queries the database and aggregates the ad-hoc orders by pixel and time steps into a demand time series - implement "heavy" integration tests for `aggregate_orders()` - make `pandas` a package dependency - streamline the `Config`
2021-01-07 23:18:40 +01:00
pandas = "^1.1.0"
Add an ORM layer - use SQLAlchemy (and PostgreSQL) to model the ORM layer - add the following models: + Address => modelling all kinds of addresses + City => model the three target cities + Courier => model the UDP's couriers + Customer => model the UDP's customers + Order => model the orders received by the UDP + Restaurant => model the restaurants active on the UDP - so far, the emphasis lies on expression the Foreign Key and Check Constraints that are used to validate the assumptions inherent to the cleanded data - provide database-independent unit tests with 100% coverage - provide additional integration tests ("e2e") that commit data to a PostgreSQL instance to validate that the constraints work - adapt linting rules a bit
2020-08-09 03:45:19 +02:00
psycopg2 = "^2.8.5" # adapter for PostgreSQL
Add folium to the dependencies
2021-01-21 11:47:22 +01:00
rpy2 = "^3.4.1"
Add an ORM layer - use SQLAlchemy (and PostgreSQL) to model the ORM layer - add the following models: + Address => modelling all kinds of addresses + City => model the three target cities + Courier => model the UDP's couriers + Customer => model the UDP's customers + Order => model the orders received by the UDP + Restaurant => model the restaurants active on the UDP - so far, the emphasis lies on expression the Foreign Key and Check Constraints that are used to validate the assumptions inherent to the cleanded data - provide database-independent unit tests with 100% coverage - provide additional integration tests ("e2e") that commit data to a PostgreSQL instance to validate that the constraints work - adapt linting rules a bit
2020-08-09 03:45:19 +02:00
sqlalchemy = "^1.3.18"
Add statsmodels to the dependencies
2021-01-31 18:24:03 +01:00
statsmodels = "^0.12.1"
Add utm to the dependencies
2021-01-01 17:59:15 +01:00
utm = "^0.7.0"
Add CLI entry point `umd` - add the following file: + src/urban_meal_delivery/console.py => click-based CLI tools + tests/test_console.py => tests for the module above - add a CLI entry point `umd`: + implement the --version / -V option to show the installed package's version + rework to package's top-level: * add a __pkg_name__ variable to parameterize the package name + add unit and integration tests - fix that pylint cannot know the proper order of imports in the isolated nox session
2020-08-04 21:14:40 +02:00
Add Jupyter Lab environment - dependencies used to run the Jupyter Lab environment that are not required by the `urban-meal-delivery` package itself are put into an installation extra called "research" - this allows to NOT install the requirements, for example, when testing the package in an isolated environment
2020-08-11 10:50:29 +02:00
# Jupyter Lab => notebooks with analyses using the developed package
# IMPORTANT: must be kept in sync with the "research" extra below
jupyterlab = { version="^2.2.2", optional=true }
nb_black = { version="^1.0.7", optional=true }
numpy = { version="^1.19.1", optional=true }
pytz = { version="^2020.1", optional=true }
[tool.poetry.extras]
research = [
"jupyterlab",
"nb_black",
"numpy",
"pytz",
]
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/
2020-08-03 20:19:42 +02:00
[tool.poetry.dev-dependencies]
Add nox as the task runner - set up skeletons for all planned nox sessions - provide a base configuration for all nox sessions - create two utility functions: + _begin() => run commands common to all sessions + _install_packages() => install dependencies in nox sessions respecting the versions pinned in poetry.lock - add the following file: + noxfile.py
2020-08-03 21:24:06 +02:00
# Task Runners
nox = "^2020.5.24"
Set up pre-commit hooks - add pre-commit and pre-merge hooks: + run `poetry run nox -s pre-commit` on staged *.py files + run common pre-commit hooks for validations that could not be achieved with tools in the develop environment so easily + run `poetry run nox -s pre-merge` before merges and pushes - implement the "pre-commit" and "pre-merge" sessions in nox + include a little hack to deal with the positional arguments passed by the pre-commit framework - provide more documentation on the nox sessions
2020-08-04 02:55:41 +02:00
pre-commit = "^2.6.0"
Add a code formatting tool chain - (auto-)format code with: + autoflake => * remove unused imports and variables * remove duplicate dict keys * expand star imports + black => enforce an uncompromising code style + isort => enforce a consistent import style (complying with Google's Python Style Guide) - implement the nox session "format" that runs all these tools - add the following file: + setup.cfg => holds configurations for the develop tools
2020-08-03 21:39:49 +02:00
# Code Formatters
autoflake = "^1.3.1"
black = "^19.10b0"
Upgrade isort to v5.5.4
2020-09-30 11:54:23 +02:00
isort = "^4.3.21" # TODO (isort): not ^5.5.4 due to wemake-python-styleguide
Add a code linting tool chain - use flake8 as the main and pylint as the auxiliary linter - install flake8 with the following plug-ins: + flake8-annotations => enforce type annotations for functions/classes + flake8-black => ensure black would not make any changes + flake8-expression-complexity + wemake-python-styleguide, which packages the following: * darglint * flake8-bandit * flake8-broken-line * flake8-bugbear * flake8-commas * flake8-comprehensions * flake8-debugger * flake8-docstrings * flake8-eradicate * flake8-isort * flake8-rst-docstrings * flake8-string-format * flake8-quotes * pep8-naming - configure flake8 & friends in a rather explicit and strict way - isort needed to be downgraded to ^4.3.21 due to a conflict with pylint and wemake-python-styleguide: + provide TODO's to remove the parts that "fix" isort - use mypy for static type checking - add a nox session "lint" that runs flake8, mypy, and pylint - lint all source files
2020-08-03 22:41:37 +02:00
# (Static) Code Analyzers
flake8 = "^3.8.3"
flake8-annotations = "^2.3.0"
flake8-black = "^0.2.1"
Add a testing tool chain - use pytest as the base, measure coverage with pytest-cov + configure coverage to include branches and specify source locations + configure pytest to enforce explicit markers - add a package for the test suite under tests/ - add a `__version__` identifier at the package's root + it is dynamically assigned the version of the installed package + the version is PEP440 compliant and follows a strict subset of semantic versioning: x.y.z[.devN] where x, y, z, and N are all non-negative integers + add module with tests for the __version__ - add a nox session "test" that runs the test suite - use flake8 to lint pytest for consistent style
2020-08-04 00:09:29 +02:00
flake8-pytest-style = "^1.2.2"
Add a code linting tool chain - use flake8 as the main and pylint as the auxiliary linter - install flake8 with the following plug-ins: + flake8-annotations => enforce type annotations for functions/classes + flake8-black => ensure black would not make any changes + flake8-expression-complexity + wemake-python-styleguide, which packages the following: * darglint * flake8-bandit * flake8-broken-line * flake8-bugbear * flake8-commas * flake8-comprehensions * flake8-debugger * flake8-docstrings * flake8-eradicate * flake8-isort * flake8-rst-docstrings * flake8-string-format * flake8-quotes * pep8-naming - configure flake8 & friends in a rather explicit and strict way - isort needed to be downgraded to ^4.3.21 due to a conflict with pylint and wemake-python-styleguide: + provide TODO's to remove the parts that "fix" isort - use mypy for static type checking - add a nox session "lint" that runs flake8, mypy, and pylint - lint all source files
2020-08-03 22:41:37 +02:00
mypy = "^0.782"
wemake-python-styleguide = "^0.14.1" # flake8 plug-in
Add a testing tool chain - use pytest as the base, measure coverage with pytest-cov + configure coverage to include branches and specify source locations + configure pytest to enforce explicit markers - add a package for the test suite under tests/ - add a `__version__` identifier at the package's root + it is dynamically assigned the version of the installed package + the version is PEP440 compliant and follows a strict subset of semantic versioning: x.y.z[.devN] where x, y, z, and N are all non-negative integers + add module with tests for the __version__ - add a nox session "test" that runs the test suite - use flake8 to lint pytest for consistent style
2020-08-04 00:09:29 +02:00
# Test Suite
Add Faker to the dev dependencies
2020-12-15 19:07:14 +01:00
Faker = "^5.0.1"
Add factory_boy to the dev dependencies
2020-12-15 12:23:45 +01:00
factory-boy = "^3.1.0"
Add geopy to the dev dependencies
2020-12-28 15:52:08 +01:00
geopy = "^2.1.0"
Add a testing tool chain - use pytest as the base, measure coverage with pytest-cov + configure coverage to include branches and specify source locations + configure pytest to enforce explicit markers - add a package for the test suite under tests/ - add a `__version__` identifier at the package's root + it is dynamically assigned the version of the installed package + the version is PEP440 compliant and follows a strict subset of semantic versioning: x.y.z[.devN] where x, y, z, and N are all non-negative integers + add module with tests for the __version__ - add a nox session "test" that runs the test suite - use flake8 to lint pytest for consistent style
2020-08-04 00:09:29 +02:00
packaging = "^20.4" # used to test the packaged version
pytest = "^6.0.1"
pytest-cov = "^2.10.0"
Add database migrations - use Alembic to migrate the PostgreSQL database + create initial migration script to set up the database, as an alternative to db.Base.metadata.create_all() + integrate Alembic into the test suite; the db_engine fixture now has two modes: * create the latest version of tables all at once * invoke `alembic upgrade head` => the "e2e" tests are all run twice, once in each mode; this ensures that the migration scripts re-create the same database schema as db.Base.metadata.create_all() would * in both modes, a temporary PostgreSQL schema is used to create the tables in => could now run "e2e" tests against production database and still have isolation - make the configuration module public (to be used by Alembic) - adjust linting rules for Alembic
2020-08-09 17:14:23 +02:00
pytest-env = "^0.6.2"
Add pytest-mock to the dev dependencies
2021-01-24 18:32:07 +01:00
pytest-mock = "^3.5.1"
Include doctests in the test suite - use xdoctest to validate all code snippets in docstrings - add xdoctest to the nox session "test"
2020-08-05 00:02:40 +02:00
xdoctest = { version="^0.13.0", extras=["optional"] }
Add CLI entry point `umd` - add the following file: + src/urban_meal_delivery/console.py => click-based CLI tools + tests/test_console.py => tests for the module above - add a CLI entry point `umd`: + implement the --version / -V option to show the installed package's version + rework to package's top-level: * add a __pkg_name__ variable to parameterize the package name + add unit and integration tests - fix that pylint cannot know the proper order of imports in the isolated nox session
2020-08-04 21:14:40 +02:00
Add technical documentation for the package - use sphinx to document the developed package - create a nox session "docs" that builds the docs - include a skeleton in the docs/ folder + how to install the package + how to use nox + license
2020-08-05 01:34:27 +02:00
# Documentation
sphinx = "^3.1.2"
sphinx-autodoc-typehints = "^1.11.0"
Add CLI entry point `umd` - add the following file: + src/urban_meal_delivery/console.py => click-based CLI tools + tests/test_console.py => tests for the module above - add a CLI entry point `umd`: + implement the --version / -V option to show the installed package's version + rework to package's top-level: * add a __pkg_name__ variable to parameterize the package name + add unit and integration tests - fix that pylint cannot know the proper order of imports in the isolated nox session
2020-08-04 21:14:40 +02:00
[tool.poetry.scripts]
Add CLI script to gridify all cities - reorganize `urban_meal_delivery.console` into a sub-package - move `tests.db.conftest` fixtures into `tests.conftest` => some integration tests regarding CLI scripts need a database - add `urban_meal_delivery.console.decorators.db_revision` decorator to ensure the database is at a certain state before a CLI script runs - refactor the `urban_meal_delivery.db.grids.Grid.gridify()` constructor: - bug fix: even empty `Pixel`s end up in the database temporarily => create `Pixel` objects only if an `Address` is to be assigned to it - streamline code and docstring - add further test cases
2021-01-06 16:17:05 +01:00
umd = "urban_meal_delivery.console:cli"
Reference in a new issue Copy permalink