NPO-Accounting/conservancy_beancount
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
conservancy_beancount/setup.py

61 lines
2.5 KiB
Python
Raw Normal View History

Initial commit: license, setup.py, gitignore, skeleton structure.
2020-03-05 14:33:23 +00:00
#!/usr/bin/env python3
from setuptools import setup
setup(
name='conservancy_beancount',
description="Plugin, library, and reports for reading Conservancy's books",
plugin: Skip enum value checks with a flag+FIXME. We've long supported skipping documentation checks by flagging the transaction. We haven't done the same for enumerated metadata because we need it less often, and bad values tend to do more damage to reports. However, occasionally when something very off-process happens, we do need it as a matter of expediency. So support it. In order to skip validation of these fields, the plugin requires that the value start with the string "FIXME". This helps ensure that reports have a consistent way to detect and warn about unfilled values in flagged transactions.
2021-01-29 14:38:37 +00:00
version='1.16.2',
Initial commit: license, setup.py, gitignore, skeleton structure.
2020-03-05 14:33:23 +00:00
author='Software Freedom Conservancy',
author_email='info@sfconservancy.org',
license='GNU AGPLv3+',
install_requires=[
reports: Add Balance.format() method.
2020-05-28 12:39:50 +00:00
'babel>=2.6', # Debian:python3-babel
setup: Document Debian packages for dependencies when available.
2020-05-25 15:16:57 +00:00
'beancount>=2.2', # Debian:beancount
config: Add Config.books_repo() method.
2020-07-29 19:46:14 +00:00
'GitPython>=2.0', # Debian:python3-git
reports: Start BaseODS class.
2020-06-03 23:03:02 +00:00
# 1.4.1 crashes when trying to save some documents.
'odfpy>=1.4.0,!=1.4.1', # Debian:python3-odf
pdfforms: Initial module and tool to extract PDF form data to YAML. Next steps: * A tool to fill the PDF form based on values written to that YAML. * An extension to fill some of those values with numbers queried from the books (which is why we need something more involved than FDF).
2021-01-04 21:10:11 +00:00
'pdfminer.six>=20200101',
setup: Document Debian packages for dependencies when available.
2020-05-25 15:16:57 +00:00
'PyYAML>=3.0', # Debian:python3-yaml
'regex', # Debian:python3-regex
config: Add Config.rt_client method.
2020-03-24 13:08:08 +00:00
'rt>=2.0',
Initial commit: license, setup.py, gitignore, skeleton structure.
2020-03-05 14:33:23 +00:00
],
setup: Introduce typecheck alias.
2020-03-18 12:14:36 +00:00
setup_requires=[
'pytest-mypy',
setup: Document Debian packages for dependencies when available.
2020-05-25 15:16:57 +00:00
'pytest-runner', # Debian:python3-pytest-runner
setup: Introduce typecheck alias.
2020-03-18 12:14:36 +00:00
],
tests_require=[
setup: Document Debian packages for dependencies when available.
2020-05-25 15:16:57 +00:00
'mypy>=0.770', # Debian:python3-mypy
'pytest', # Debian:python3-pytest
setup: Introduce typecheck alias.
2020-03-18 12:14:36 +00:00
],
Initial commit: license, setup.py, gitignore, skeleton structure.
2020-03-05 14:33:23 +00:00
setup: Install subpackages.
2020-05-18 13:21:08 +00:00
packages=[
'conservancy_beancount',
pdfforms: Initial module and tool to extract PDF form data to YAML. Next steps: * A tool to fill the PDF form based on values written to that YAML. * An extension to fill some of those values with numbers queried from the books (which is why we need something more involved than FDF).
2021-01-04 21:10:11 +00:00
'conservancy_beancount.pdfforms',
extract: Lay the groundwork for specialized PDF extractors. * Start a whole extract submodule. * Parametrize FormExtractor. * Add a FormExtractor._transform_fields() hook.
2021-01-09 20:16:07 +00:00
'conservancy_beancount.pdfforms.extract',
setup: Install subpackages.
2020-05-18 13:21:08 +00:00
'conservancy_beancount.plugin',
reconcile: Start module with PayPal reconciliation report.
2021-01-23 15:23:03 +00:00
'conservancy_beancount.reconcile',
setup: Install subpackages.
2020-05-18 13:21:08 +00:00
'conservancy_beancount.reports',
setup: Install tools module.
2020-08-31 21:05:51 +00:00
'conservancy_beancount.tools',
setup: Install subpackages.
2020-05-18 13:21:08 +00:00
],
reports.accrual: Begin reporting. This module basically reimplements the old payment-report+income-report, in a single tool (after setting aside some of the checks that have moved to the plugin). The aging report can be implemented here too when we need that.
2020-05-04 20:36:59 +00:00
entry_points={
'console_scripts': [
cliutil: Add make_entry_point() function. This provides better logging setup, reduces the amount of boilerplate in main, and replaces is_main_script().
2020-06-12 19:08:08 +00:00
'accrual-report = conservancy_beancount.reports.accrual:entry_point',
audit_report: New tool.
2020-08-31 02:34:32 +00:00
'assemble-audit-reports = conservancy_beancount.tools.audit_report:entry_point',
balance_sheet: Start report with financial position. RT#11854.
2020-08-17 01:14:09 +00:00
'balance-sheet-report = conservancy_beancount.reports.balance_sheet:entry_point',
reports: Initial budget variance skeleton. RT#12680 This is a *very* rough initial draft of a report. As the docstring mentions, it's basically counting on the user to provide rewrite rules to provide the desired representation. Long-term I'm hoping maybe we can standardize the program metadata enough, or plan its replacement well enough, that this report can be written against that directly. But that will take more planning about books structure, and support from the plugin, before the report can be written that way.
2020-10-26 18:57:15 +00:00
'budget-report = conservancy_beancount.reports.budget:entry_point',
sort_entries: New tool.
2020-10-06 14:38:39 +00:00
'bean-sort = conservancy_beancount.tools.sort_entries:entry_point',
tools: Add extract-odf-links.
2020-08-10 14:02:40 +00:00
'extract-odf-links = conservancy_beancount.tools.extract_odf_links:entry_point',
fund: New report.
2020-06-21 19:27:43 +00:00
'fund-report = conservancy_beancount.reports.fund:entry_point',
ledger: New reporting module.
2020-06-16 14:18:18 +00:00
'ledger-report = conservancy_beancount.reports.ledger:entry_point',
opening_balances: New tool.
2020-06-25 14:51:37 +00:00
'opening-balances = conservancy_beancount.tools.opening_balances:entry_point',
pdfforms: Initial module and tool to extract PDF form data to YAML. Next steps: * A tool to fill the PDF form based on values written to that YAML. * An extension to fill some of those values with numbers queried from the books (which is why we need something more involved than FDF).
2021-01-04 21:10:11 +00:00
'pdfform-extract = conservancy_beancount.pdfforms.extract:entry_point',
irs990scheduleA: New PDF extractor.
2021-01-09 20:17:55 +00:00
'pdfform-extract-irs990scheduleA = conservancy_beancount.pdfforms.extract.irs990scheduleA:entry_point',
pdfforms.fill: New module+tool. After you edit the YAML generated by pdfform-extract, you can re-fill the original PDF with pdfform-fill.
2021-01-05 23:30:00 +00:00
'pdfform-fill = conservancy_beancount.pdfforms.fill:entry_point',
reconcile: Start module with PayPal reconciliation report.
2021-01-23 15:23:03 +00:00
'reconcile-paypal = conservancy_beancount.reconcile.paypal:entry_point',
split_ods_links: New tool. See docstring—this is mostly a post-filter to improve Excel compatibility.
2020-09-09 03:37:00 +00:00
'split-ods-links = conservancy_beancount.tools.split_ods_links:entry_point',
reports.accrual: Begin reporting. This module basically reimplements the old payment-report+income-report, in a single tool (after setting aside some of the checks that have moved to the plugin). The aging report can be implemented here too when we need that.
2020-05-04 20:36:59 +00:00
],
},
Initial commit: license, setup.py, gitignore, skeleton structure.
2020-03-05 14:33:23 +00:00
)
Reference in a new issue Copy permalink