CPI
/
superx-budget-overview
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

updated project to latest cookiecutter

main
Holger Frey 3 years ago
parent
26a0749372
commit
55b05596b6
15 changed files with 96 additions and 80 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      .flake8
  2. 3
      .gitignore
  3. 8
      CONTRIBUTING.md
  4. 14
      Makefile
  5. 61
      pyproject.toml
  6. 6
      requirements.txt
  7. 4
      superx_budget/budget.py
  8. 2
      superx_budget/exceptions.py
  9. 14
      superx_budget/helpers.py
  10. 20
      superx_budget/overview.py
  11. 4
      superx_budget/pyramid/__init__.py
  12. 12
      superx_budget/superx.py
  13. 6
      tests/test_budget_parser.py
  14. 14
      tests/test_overview.py
  15. 6
      tests/test_superx_parser.py

2
.flake8
Unescape View File

@ -0,0 +1,2 @@
[flake8]
per-file-ignores = tests/*:S101

3
.gitignore vendored
Unescape View File

@ -45,7 +45,6 @@ htmlcov/
nosetests.xml nosetests.xml
coverage.xml coverage.xml
*,cover *,cover
mail/
# Translations # Translations
*.mo *.mo
@ -63,5 +62,3 @@ target/
# Mac Stuff # Mac Stuff
.DS_Store .DS_Store
# Pyramid
production.ini

8
CONTRIBUTING.md
Unescape View File

@ -11,7 +11,7 @@ Types of Contributions
### Report Bugs ### Report Bugs
Report bugs at https://github.com/holgi/superx_budget/issues. Report bugs at https://git.cpi.imtek.uni-freiburg.de/CPI/superx-budget-overview.git/issues.
If you are reporting a bug, please include: If you are reporting a bug, please include:
@ -31,13 +31,13 @@ and "help wanted" is open to whoever wants to implement it.
### Write Documentation ### Write Documentation
superx_budget could always use more documentation, whether as part of the SuperX Budget could always use more documentation, whether as part of the
official superx_budget docs, in docstrings, or even on the web in blog posts, official SuperX Budget docs, in docstrings, or even on the web in blog posts,
articles, and such. articles, and such.
### Submit Feedback ### Submit Feedback
The best way to send feedback is to file an issue at https://github.com/holgi/superx_budget/issues. The best way to send feedback is to file an issue at https://git.cpi.imtek.uni-freiburg.de/CPI/superx-budget-overview.git/issues.
If you are proposing a feature: If you are proposing a feature:

14
Makefile
Unescape View File

@ -57,10 +57,13 @@ lint: ## reformat with black and check style with flake8
flake8 superx_budget tests flake8 superx_budget tests
test: lint ## run tests quickly with the default Python test: lint ## run tests quickly with the default Python
pytest tests -x --disable-warnings -m "not app" pytest tests -x --disable-warnings -m "not fun"
testall: lint ## run tests quickly with the default Python
pytest tests
coverage: lint ## full test suite, check code coverage and open coverage report coverage: lint ## full test suite, check code coverage and open coverage report
pytest tests --cov=superx_budget pytest tests --cov=superx_budget -m "fun"
coverage html coverage html
$(BROWSER) htmlcov/index.html $(BROWSER) htmlcov/index.html
@ -73,12 +76,15 @@ install: ## install updated project.toml with flint
devenv: ## setup development environment devenv: ## setup development environment
python3 -m venv --prompt superx_budget .venv python3 -m venv --prompt superx_budget .venv
.venv/bin/pip3 install --upgrade pip .venv/bin/pip3 install --upgrade pip
.venv/bin/pip3 install flit .venv/bin/pip3 install "flit>3.2"
.venv/bin/flit install --pth-file .venv/bin/flit install --pth-file
repo: devenv ## complete project setup with development environment and git repo repo: devenv ## complete project setup with development environment and git repo
git init . git init .
git branch -m main
git add . git add .
git commit -m "import of project template" git commit -m "import of project template"
git remote add origin https://git.cpi.imtek.uni-freiburg.de/CPI/superx-budget-overview.git
git push -u origin main --no-verify
.venv/bin/pre-commit install --install-hooks .venv/bin/pre-commit install --install-hooks

61
pyproject.toml
Unescape View File

@ -4,14 +4,17 @@
requires = ["flit"] requires = ["flit"]
build-backend = "flit.buildapi" build-backend = "flit.buildapi"
[tool.flit.metadata] [project]
module = "superx_budget" name = "superx_budget"
dist-name = "superx_budget" readme = "README.md"
author = "Holger Frey" description = "Creating a budget overview from a SuperX export."
author-email = "frey@imtek.de" license = { file = "LICENSE" }
home-page = "https://github.com/holgi/superx_budget" requires-python = ">=3.7"
description-file = "README.md" dynamic = ["version"]
license = "Beerware"
authors = [
{name = "Holger Frey", email = "frey@imtek.de"},
]
# see https://pypi.org/classifiers/ # see https://pypi.org/classifiers/
classifiers = [ classifiers = [
@ -23,7 +26,7 @@ classifiers = [
"License :: Freely Distributable", "License :: Freely Distributable",
] ]
requires = [ dependencies = [
"openpyxl >= 3.0.0", "openpyxl >= 3.0.0",
"pyramid >= 1.10", "pyramid >= 1.10",
"pyramid_jinja2 >= 2.7", "pyramid_jinja2 >= 2.7",
@ -31,39 +34,43 @@ requires = [
"waitress >= 1.4.3", "waitress >= 1.4.3",
"passlib[argon2] >= 1.7.2", "passlib[argon2] >= 1.7.2",
] ]
requires-python = ">=3.7"
[tool.flit.metadata.requires-extra] [project.entrypoints."paste.app_factory"]
main = "superx_budget:main"
[project.urls]
Source = "https://git.cpi.imtek.uni-freiburg.de/CPI/superx-budget-overview.git"
[project.optional-dependencies]
test = [ test = [
"pytest >=4.0.0", "pytest >=4.0.0",
"pytest-cov", "pytest-cov",
"pytest-mock", "pytest-mock",
"pytest-randomly",
"tox", "tox",
] ]
dev = [ dev = [
"black", "black",
"flake8", "flake8",
"flake8-comprehensions", "flake8-comprehensions",
"flake8-bandit",
"isort >= 5.0.0", "isort >= 5.0.0",
"keyring", "keyring",
"pre-commit", "pre-commit",
] ]
[tool.flit.entrypoints."paste.app_factory"]
main = "superx_budget:main"
[tool.black] [tool.black]
line-length = 79 line-length = 79
py37 = true target-version = ['py37','py38', 'py39']
include = '\.pyi?$' include = '\.pyi?$'
exclude = ''' extend-exclude = '''
/( # A regex preceded with ^/ will apply only to files and directories
\.git # in the root of the project.
| \.tox ^/.git
| \.venv ^/.tox
| build ^/.venv
| dist ^/.build
)/ ^/.dist
''' '''
[tool.isort] [tool.isort]
@ -71,3 +78,11 @@ line_length=79
multi_line_output=3 multi_line_output=3
length_sort="True" length_sort="True"
include_trailing_comma="True" include_trailing_comma="True"
[tool.pytest.ini_options]
markers = [
"fun: marks tests as functional (deselect with '-m \"not fun\"')",
]
addopts = [
"--strict-markers",
]

6
requirements.txt
Unescape View File

@ -1,6 +0,0 @@
openpyxl==3.0.5
pyramid==1.10.4
pyramid-jinja2==2.8
pyramid-mailer==0.15.1
waitress==1.4.4
passlib==1.7.2

4
superx_budget/budget.py
Unescape View File

@ -56,13 +56,13 @@ def _parse_data_table(rows):
def parse_budget_data(xls_sheet): def parse_budget_data(xls_sheet):
""" parses the budget data """ """parses the budget data"""
rows = (ExcelRow(i, v) for i, v in enumerate(xls_sheet.values, start=1)) rows = (ExcelRow(i, v) for i, v in enumerate(xls_sheet.values, start=1))
_check_table_header(next(rows)) _check_table_header(next(rows))
return list(_parse_data_table(rows)) return list(_parse_data_table(rows))
def parse_budget_file(file_path): def parse_budget_file(file_path):
""" parses the budget file """ """parses the budget file"""
sheet = get_sheet_of_file(file_path, sheet=None) sheet = get_sheet_of_file(file_path, sheet=None)
return parse_budget_data(sheet) return parse_budget_data(sheet)

2
superx_budget/exceptions.py
Unescape View File

@ -2,7 +2,7 @@
class SuperXBudgetError(ValueError): class SuperXBudgetError(ValueError):
""" Base class for project errors """ """Base class for project errors"""
class SuperXParserError(SuperXBudgetError): class SuperXParserError(SuperXBudgetError):

14
superx_budget/helpers.py
Unescape View File

@ -19,7 +19,7 @@ def excel_value_as_number(value):
def get_sheet_of_file(excel_file, sheet=None): def get_sheet_of_file(excel_file, sheet=None):
""" returns a sheet from an excel FileCache """returns a sheet from an excel FileCache
if name is set to None, the function returns the first sheet if name is set to None, the function returns the first sheet
""" """
@ -31,7 +31,7 @@ def get_sheet_of_file(excel_file, sheet=None):
def is_empty_excel_value(value): def is_empty_excel_value(value):
""" is the cell value considered empty """ """is the cell value considered empty"""
if value is None: if value is None:
return True return True
if isinstance(value, str) and value.strip() == "": if isinstance(value, str) and value.strip() == "":
@ -40,14 +40,14 @@ def is_empty_excel_value(value):
def strip_excel_value(value): def strip_excel_value(value):
""" remove whitespace from an excel value if it is a string """ """remove whitespace from an excel value if it is a string"""
if isinstance(value, str): if isinstance(value, str):
return value.strip() return value.strip()
return value return value
def is_budget_file_name(path_or_name): def is_budget_file_name(path_or_name):
""" checks if a filename has the format "budget[...]-<year>.xlsx """ """checks if a filename has the format "budget[...]-<year>.xlsx"""
path = Path(path_or_name) path = Path(path_or_name)
if not path.suffix.lower() == ".xlsx": if not path.suffix.lower() == ".xlsx":
return False return False
@ -61,21 +61,21 @@ def is_budget_file_name(path_or_name):
def list_budget_files(folder): def list_budget_files(folder):
""" lists all files with the name "budget[...]-<year>.xlsx """ """lists all files with the name "budget[...]-<year>.xlsx"""
files = (i for i in Path(folder).iterdir() if i.is_file()) files = (i for i in Path(folder).iterdir() if i.is_file())
visible = (i for i in files if not i.name.startswith(".")) visible = (i for i in files if not i.name.startswith("."))
return [i for i in visible if is_budget_file_name(i)] return [i for i in visible if is_budget_file_name(i)]
def find_budget_file(folder, year): def find_budget_file(folder, year):
""" searches for a file with the name "budget[...]-<year>.xlsx """ """searches for a file with the name "budget[...]-<year>.xlsx"""
for path in list_budget_files(folder): for path in list_budget_files(folder):
if path.stem.endswith(f"-{year}"): if path.stem.endswith(f"-{year}"):
return path return path
def find_recipients(folder, filename="recipients.txt"): def find_recipients(folder, filename="recipients.txt"):
""" finds the recipients of the budget list """ """finds the recipients of the budget list"""
file_path = folder / filename file_path = folder / filename
if file_path.is_file(): if file_path.is_file():
with file_path.open() as filehandle: with file_path.open() as filehandle:

20
superx_budget/overview.py
Unescape View File

@ -19,41 +19,41 @@ OverviewBudgetEntry = namedtuple(
class ProjectOverview: class ProjectOverview:
def __init__(self, budget_data): def __init__(self, budget_data):
""" initializes the class """ """initializes the class"""
self.budget_data = budget_data self.budget_data = budget_data
self.entries = [] self.entries = []
self.found = False self.found = False
@property @property
def project(self): def project(self):
""" returns the project number """ """returns the project number"""
return self.budget_data.project return self.budget_data.project
@property @property
def row(self): def row(self):
""" returns the excel row number """ """returns the excel row number"""
return self.budget_data.row return self.budget_data.row
@property @property
def expenses(self): def expenses(self):
""" returns the accumulated expenses """ """returns the accumulated expenses"""
numbers = (excel_value_as_number(e.amount) for e in self.entries) numbers = (excel_value_as_number(e.amount) for e in self.entries)
values = (abs(entry) for entry in numbers) values = (abs(entry) for entry in numbers)
return sum(values) return sum(values)
@property @property
def available(self): def available(self):
""" returns the still available budget """ """returns the still available budget"""
return self.budget_data.budget - self.expenses return self.budget_data.budget - self.expenses
def add(self, description, kind, amount): def add(self, description, kind, amount):
""" adds an entry that modifies the available budget """ """adds an entry that modifies the available budget"""
entry = OverviewBudgetEntry(description, kind, amount) entry = OverviewBudgetEntry(description, kind, amount)
self.entries.append(entry) self.entries.append(entry)
def _create_overview_map(budget_list): def _create_overview_map(budget_list):
""" returns a dictonary with project as key and overview as value """ """returns a dictonary with project as key and overview as value"""
map = {} map = {}
for budget_data in budget_list: for budget_data in budget_list:
overview = ProjectOverview(budget_data) overview = ProjectOverview(budget_data)
@ -62,12 +62,12 @@ def _create_overview_map(budget_list):
def _filter_superx_material_expenses(superx_export): def _filter_superx_material_expenses(superx_export):
""" filters superx data to only contain material entries """ """filters superx data to only contain material entries"""
return (i for i in superx_export.data if i.kind in VALID_MATERIAL_IDS) return (i for i in superx_export.data if i.kind in VALID_MATERIAL_IDS)
def _create_entries_from_superx(overview_map, superx_export_data): def _create_entries_from_superx(overview_map, superx_export_data):
""" adds overview entries from superx data """ """adds overview entries from superx data"""
for line in superx_export_data: for line in superx_export_data:
if line.project in overview_map: if line.project in overview_map:
overview = overview_map[line.project] overview = overview_map[line.project]
@ -85,7 +85,7 @@ def _set_found_state(overview_map, superx_export):
def create_overview(budget_list, superx_export): def create_overview(budget_list, superx_export):
""" create a overview map with budget entries from the parsed raw data """ """create a overview map with budget entries from the parsed raw data"""
tmp_map = _create_overview_map(budget_list) tmp_map = _create_overview_map(budget_list)
overview_map = _set_found_state(tmp_map, superx_export) overview_map = _set_found_state(tmp_map, superx_export)
material_expenses = _filter_superx_material_expenses(superx_export) material_expenses = _filter_superx_material_expenses(superx_export)

4
superx_budget/pyramid/__init__.py
Unescape View File

@ -5,7 +5,7 @@ from pathlib import Path
from pyramid.view import notfound_view_config from pyramid.view import notfound_view_config
from pyramid.config import Configurator from pyramid.config import Configurator
from pyramid.session import JSONSerializer, SignedCookieSessionFactory from pyramid.session import JSONSerializer, SignedCookieSessionFactory
from pyramid.security import Allow, Everyone, Authenticated from pyramid.authorization import Allow, Everyone, Authenticated
from pyramid.httpexceptions import HTTPFound from pyramid.httpexceptions import HTTPFound
from ..overview import create_overview # noqa: F401 from ..overview import create_overview # noqa: F401
@ -23,7 +23,7 @@ class Root:
def main(global_config, **settings): def main(global_config, **settings):
""" This function returns a Pyramid WSGI application. """ """This function returns a Pyramid WSGI application."""
with Configurator(settings=settings) as config: with Configurator(settings=settings) as config:
session_factory = SignedCookieSessionFactory( session_factory = SignedCookieSessionFactory(

12
superx_budget/superx.py
Unescape View File

@ -33,14 +33,14 @@ SuperXData = namedtuple(
def _check_export_headline(row): def _check_export_headline(row):
""" checks the first line of the excel data if it's what we'd expect """ """checks the first line of the excel data if it's what we'd expect"""
headline = row[0] headline = row[0]
if headline != EXPECTED_HEADLINE: if headline != EXPECTED_HEADLINE:
raise SuperXParserError(f"unexpected headline: '{headline}'") raise SuperXParserError(f"unexpected headline: '{headline}'")
def _get_export_metadata(row): def _get_export_metadata(row):
""" extracts the metadata from the second row of the excel sheet """ """extracts the metadata from the second row of the excel sheet"""
data = row[0] data = row[0]
entries = data.split(";") entries = data.split(";")
parts = [entry.split(":", 1) for entry in entries] parts = [entry.split(":", 1) for entry in entries]
@ -59,7 +59,7 @@ def _get_export_metadata(row):
def _skip_export_data_until_table_header(rows): def _skip_export_data_until_table_header(rows):
""" skip rows until data table headers """ """skip rows until data table headers"""
for line in rows: for line in rows:
first_cell = line[0] first_cell = line[0]
if first_cell == EXPECTED_DATA_TABLE_HEADER: if first_cell == EXPECTED_DATA_TABLE_HEADER:
@ -69,7 +69,7 @@ def _skip_export_data_until_table_header(rows):
def _parse_data_table(rows): def _parse_data_table(rows):
""" parses non-empty lines of the data table """ """parses non-empty lines of the data table"""
for line in rows: for line in rows:
if not line[0]: if not line[0]:
continue continue
@ -78,7 +78,7 @@ def _parse_data_table(rows):
def parse_export_data(xls_sheet): def parse_export_data(xls_sheet):
""" parses the exported superx data """ """parses the exported superx data"""
rows = xls_sheet.values rows = xls_sheet.values
_check_export_headline(next(rows)) _check_export_headline(next(rows))
metadata = _get_export_metadata(next(rows)) metadata = _get_export_metadata(next(rows))
@ -88,6 +88,6 @@ def parse_export_data(xls_sheet):
def parse_exported_file(file_path): def parse_exported_file(file_path):
""" parses the budget file """ """parses the budget file"""
sheet = get_sheet_of_file(file_path, sheet=None) sheet = get_sheet_of_file(file_path, sheet=None)
return parse_export_data(sheet) return parse_export_data(sheet)

6
tests/test_budget_parser.py
Unescape View File

@ -2,7 +2,7 @@ import pytest
def test_check_table_header_raises_error(): def test_check_table_header_raises_error():
from superx_budget.budget import _check_table_header, ExcelRow from superx_budget.budget import ExcelRow, _check_table_header
from superx_budget.exceptions import BudgetParserError from superx_budget.exceptions import BudgetParserError
row = ExcelRow(None, ["not", "the", "expected", "row", None, 0]) row = ExcelRow(None, ["not", "the", "expected", "row", None, 0])
@ -12,7 +12,7 @@ def test_check_table_header_raises_error():
def test_skip_empty_lines(): def test_skip_empty_lines():
from superx_budget.budget import _skip_empty_lines, ExcelRow from superx_budget.budget import ExcelRow, _skip_empty_lines
rows = [ rows = [
ExcelRow(0, [""]), ExcelRow(0, [""]),
@ -29,7 +29,7 @@ def test_skip_empty_lines():
def test_parse_data_table(): def test_parse_data_table():
from superx_budget.budget import _parse_data_table, ExcelRow from superx_budget.budget import ExcelRow, _parse_data_table
rows = [ rows = [
ExcelRow(2, list("ABCDEFG")), ExcelRow(2, list("ABCDEFG")),

14
tests/test_overview.py
Unescape View File

@ -79,8 +79,8 @@ def test_project_overview_available_property(example_budget_data):
def test_create_overview_map(budget_example_file): def test_create_overview_map(budget_example_file):
from superx_budget.overview import _create_overview_map
from superx_budget.budget import parse_budget_file from superx_budget.budget import parse_budget_file
from superx_budget.overview import _create_overview_map
budget_data = parse_budget_file(budget_example_file) budget_data = parse_budget_file(budget_example_file)
result = _create_overview_map(budget_data) result = _create_overview_map(budget_data)
@ -92,12 +92,12 @@ def test_create_overview_map(budget_example_file):
def test_create_entries_from_export(budget_example_file, superx_example_file): def test_create_entries_from_export(budget_example_file, superx_example_file):
from superx_budget.budget import parse_budget_file
from superx_budget.superx import parse_exported_file
from superx_budget.overview import ( from superx_budget.overview import (
_create_entries_from_superx,
_create_overview_map, _create_overview_map,
_create_entries_from_superx,
) )
from superx_budget.budget import parse_budget_file
from superx_budget.superx import parse_exported_file
superx_data = parse_exported_file(superx_example_file) superx_data = parse_exported_file(superx_example_file)
budget_data = parse_budget_file(budget_example_file) budget_data = parse_budget_file(budget_example_file)
@ -109,11 +109,11 @@ def test_create_entries_from_export(budget_example_file, superx_example_file):
def test_filter_superx_material_expenses(superx_example_file): def test_filter_superx_material_expenses(superx_example_file):
from superx_budget.superx import parse_exported_file
from superx_budget.overview import ( from superx_budget.overview import (
_filter_superx_material_expenses,
VALID_MATERIAL_IDS, VALID_MATERIAL_IDS,
_filter_superx_material_expenses,
) )
from superx_budget.superx import parse_exported_file
superx_data = parse_exported_file(superx_example_file) superx_data = parse_exported_file(superx_example_file)
result = list(_filter_superx_material_expenses(superx_data)) result = list(_filter_superx_material_expenses(superx_data))
@ -124,9 +124,9 @@ def test_filter_superx_material_expenses(superx_example_file):
def test_create_overview(budget_example_file, superx_example_file): def test_create_overview(budget_example_file, superx_example_file):
from superx_budget.overview import create_overview
from superx_budget.budget import parse_budget_file from superx_budget.budget import parse_budget_file
from superx_budget.superx import parse_exported_file from superx_budget.superx import parse_exported_file
from superx_budget.overview import create_overview
superx_data = parse_exported_file(superx_example_file) superx_data = parse_exported_file(superx_example_file)
budget_data = parse_budget_file(budget_example_file) budget_data = parse_budget_file(budget_example_file)

6
tests/test_superx_parser.py
Unescape View File

@ -15,9 +15,10 @@ def test_check_export_headline():
def test_get_export_metadata_ok(): def test_get_export_metadata_ok():
from superx_budget.superx import _get_export_metadata
from datetime import datetime from datetime import datetime
from superx_budget.superx import _get_export_metadata
value = "Haushaltsjahr: XXX;Stand:31.12.2020;Gruppierung:automatisch" value = "Haushaltsjahr: XXX;Stand:31.12.2020;Gruppierung:automatisch"
row = [value] row = [value]
metadata = _get_export_metadata(row) metadata = _get_export_metadata(row)
@ -88,9 +89,10 @@ def test_parse_data_table():
def test_parse_export_data(superx_example_workbook): def test_parse_export_data(superx_example_workbook):
from superx_budget.superx import parse_export_data
from datetime import datetime from datetime import datetime
from superx_budget.superx import parse_export_data
result = parse_export_data(superx_example_workbook.active) result = parse_export_data(superx_example_workbook.active)
assert result.account_year == "2020" assert result.account_year == "2020"

Write Preview
Loading…
Cancel
Save