alexander/urban-meal-delivery
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions
urban-meal-delivery/src/urban_meal_delivery/__init__.py

37 lines
934 B
Python
Raw Normal View History

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
"""Source code for the urban-meal-delivery research project.
Example:
>>> import urban_meal_delivery as umd
>>> umd.__version__ != '0.0.0'
True
"""
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
Add a config object - add the following file: + src/urban_meal_delivery/_config.py - a config module is created holding two sets of configurations: + production => against the real database + testing => against a database with test data - the module is "protected" (i.e., underscore) and imported at the top level via a proxy-like object `config` that detects in which of the two environments the package is being run
2020-08-08 14:43:02 +02:00
import os as _os
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
from importlib import metadata as _metadata
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
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
from urban_meal_delivery import configuration as _configuration
Add a config object - add the following file: + src/urban_meal_delivery/_config.py - a config module is created holding two sets of configurations: + production => against the real database + testing => against a database with test data - the module is "protected" (i.e., underscore) and imported at the top level via a proxy-like object `config` that detects in which of the two environments the package is being run
2020-08-08 14:43:02 +02:00
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
try:
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
_pkg_info = _metadata.metadata(__name__)
except _metadata.PackageNotFoundError: # pragma: no cover
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
__author__ = 'unknown'
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
__pkg_name__ = 'unknown'
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
__version__ = 'unknown'
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
else:
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
__author__ = _pkg_info['author']
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
__pkg_name__ = _pkg_info['name']
__version__ = _pkg_info['version']
Add a config object - add the following file: + src/urban_meal_delivery/_config.py - a config module is created holding two sets of configurations: + production => against the real database + testing => against a database with test data - the module is "protected" (i.e., underscore) and imported at the top level via a proxy-like object `config` that detects in which of the two environments the package is being run
2020-08-08 14:43:02 +02:00
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
# Global `config` object to be used in the package.
config: _configuration.Config = _configuration.make_config(
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
'testing' if _os.getenv('TESTING') else 'production',
)
# Import `db` down here as it depends on `config`.
# pylint:disable=wrong-import-position
from urban_meal_delivery import db # noqa:E402,F401 isort:skip
Reference in a new issue Copy permalink