Package Skeleton

[lasuk]

Objective

Create a package skeleton similar to the cashctrl_api package, but focused on the implementation of the CashCtrlLedger class. The package will include standard project documentation, a module named ledger.py, unit tests, and necessary setup for development and continuous integration.

Tasks

1. Set Up Basic Package Structure

Create the following files structure with appropriate documentation files and initial code:

root
├── .gitignore
├── README.md
├── LICENSE
├── setup.py
├── workflows
│   └── check-release.yml
├── cashctrl_ledger
│   ├── __init__.py
│   └── ledger.py
└── tests
    └── test_dummy.py

• Populate README.md with initial project information.
• Add docstrings for the package, classes, and one-line module docstrings.

2. Implement CashCtrlLedger Class

• In ledger.py, create a skeleton CashCtrlLedger class derived from pyledger.LedgerEngine.
• Implement an api_client property that can be optionally initialized:

  def __init__(client: CashCtrlClient | None = None):
      super().__init__()
      self._client = CashCtrlClient() if client is None else client

• I believe that Python requires all abstract methods from the base class to be overridden. In the initial skeleton, all shall raise a NotImplementedError. Example: https://github.com/macxred/pyledger/blob/a873fe411d/pyledger/standalone_ledger.py#L657

3. Testing

• Add credentials for your CashCtrl test account as GitHub secrets (see cashctrl_api repo).
• test_dummy.py should include a basic unit test to instantiate the class and check API connectivity.
• Validate GitHub Actions by committing a purposefully failing test, observing the failure, then fixing the test and confirming the workflow succeeds.

4. Submit Pull Request

• Assign a pull request for review to @lasuk.
• Include a review of the package skeleton by ChatGPT as a comment to the pull request. Possible prompt:

  > Review this skeleton of a Python package, focus on implementing community standards and best practices. Compare to other open source projects. [upload files]
  > Provide as downloadable markdown file for use in a GitHub pull request.

Additional Details

• Instead of duplicating the CONTRIBUTING.md from cashctrl_api, link to it directly in the README.md:

  [Contributing Guidelines](macxred/cashctrl_api/CONTRIBUTING.md)

• List required dependencies in setup.py with explicit links to the respective GitHub repositories where necessary:

  install_requires=[
      'pandas',
      'cashctrl_api @ https://github.com/macxred/cashctrl_api/tarball/main',
      'pyledger @ https://github.com/macxred/pyledger/tarball/main'
  ]

• When sharing ChatGPT output, I propose to include the prompt in an expandable html 'details' section at the top to enhance group learning. Example:

  <details> <summary>Click for ChatGPT prompt</summary>
  
  > Review this skeleton of a Python package, focus on implementing community standards and best practices. Compare to other open source projects. [upload files]
  > Provide as downloadable markdown file for use in a GitHub pull request.
  
  </details>