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

30 lines
765 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 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
from urban_meal_delivery import _config # noqa:WPS450
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
# Little Hack: "Overwrites" the config module so that the environment is already set.
config = _config.get_config('testing' if _os.getenv('TESTING') else 'production')
Reference in a new issue Copy permalink