diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 888a8b0..f9bfece 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,17 @@ jobs: steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 + #---------------------------------------------- + # load pip cache if cache exists + #---------------------------------------------- + - uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip + restore-keys: ${{ runner.os }}-pip + #---------------------------------------------- + # install and run linters + #---------------------------------------------- - run: python -m pip install black isort - run: | black . --check @@ -22,10 +33,13 @@ jobs: strategy: fail-fast: false matrix: - os: [ubuntu-latest, windows-latest, macos-latest] + os: [ubuntu-latest, macos-latest] python-version: ["3.9", "3.10"] runs-on: ${{ matrix.os }} steps: + #---------------------------------------------- + # check-out repo and set-up python + #---------------------------------------------- - name: Check out repository uses: actions/checkout@v1 - name: Set up python ${{ matrix.python-version }} @@ -33,13 +47,37 @@ jobs: with: python-version: ${{ matrix.python-version }} architecture: x64 + #---------------------------------------------- + # ----- install & configure poetry ----- + #---------------------------------------------- - name: Install Poetry - run: | - python -m pip install --upgrade pip - python -m pip install poetry + uses: snok/install-poetry@v1 + with: + virtualenvs-create: true + virtualenvs-in-project: true + #---------------------------------------------- + # load cached venv if cache exists + #---------------------------------------------- + - name: Load cached venv + id: cache-python-packages + uses: actions/cache@v2 + with: + path: .venv + key: venv-${{ runner.os }}-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }} + #---------------------------------------------- + # install dependencies if cache does not exist + #---------------------------------------------- - name: Install dependencies - shell: bash - run: | - python -m poetry install - - name: Run tests and check coverage - run: python -m poetry run pytest -v + if: steps.cache-python-packages.outputs.cache-hit != 'true' + run: poetry install --no-interaction --no-root + #---------------------------------------------- + # install your root project, if required + #---------------------------------------------- + - name: Install library + run: poetry install --no-interaction + #---------------------------------------------- + # run test suite + #---------------------------------------------- + - run: | + source .venv/bin/activate + poetry run pytest -v diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..1ee38af --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,59 @@ +# Contributing to FinPack + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## We develop with Github + +We use github to host code, to track issues and feature requests, as well as accept pull requests. + +## We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through Pull Requests + +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: + +1. Open an issue to discuss with code owners before making a change. +2. Fork the repo and create your branch from `master`. +3. If you've added code that should be tested, add tests. +4. If you've changed APIs, update the documentation. +5. Ensure the test suite passes. +6. Make sure your code lints (isort and black). +7. Issue that pull request! + +## Any contributions you make will be under the Apache 2.0 Software License + +In short, when you submit code changes, your submissions are understood to be under the same [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) that covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using Github's issues + +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/RackReaver/FinPack/issues/new?labels=bug); it's that easy! + +## Write bug reports with detail, background, and sample code + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can; sample code that _anyone_ with a base python 3.x setup can run to reproduce what I was seeing. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +People _love_ thorough bug reports. I'm not even kidding. + +## Use a Consistent Coding Style + +- We have setup a pre-commit-config.yaml containing all the checks, here is the command: `poetry run pre-commit` + +## License + +By contributing, you agree that your contributions will be licensed under its [Apache License 2.0](LICENSE). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6c64555 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright 2021 - Present @RackReaver + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/tests/test_cli.py b/tests/test_cli.py new file mode 100644 index 0000000..0eb4f1b --- /dev/null +++ b/tests/test_cli.py @@ -0,0 +1,108 @@ +"""Contains tests for finpack/core/cli.py +""" +__copyright__ = "Copyright (C) 2021 Matt Ferreira" + +import os +import unittest +from importlib import metadata + +from docopt import docopt + +from finpack.core import cli + + +class TestCli(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.DATA_DIR = "temp" + + os.mkdir(cls.DATA_DIR) + + @classmethod + def tearDownClass(cls): + os.rmdir(cls.DATA_DIR) + + def test_version_option(self): + argv = ["--version"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["--version"]) + + def test_init_no_options(self): + argv = ["init"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["init"]) + + def test_init_with_filepath_option(self): + argv = ["init", "--filepath=temp/data.csv"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["init"]) + self.assertEqual(args["--filepath"], "temp/data.csv") + + def test_init_with_sample_dataset_option(self): + argv = ["init", "--sample-dataset"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["init"]) + self.assertTrue(args["--sample-dataset"]) + + def test_init_with_overwrite_option(self): + argv = ["init", "--overwrite"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["init"]) + self.assertTrue(args["--overwrite"]) + + def test_balsheet_no_option(self): + argv = ["balsheet"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + + def test_balsheet_with_filepath_option(self): + argv = ["balsheet", "--filepath=temp/data2.csv"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + self.assertEqual(args["--filepath"], "temp/data2.csv") + + def test_balsheet_with_levels_default(self): + argv = ["balsheet"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + self.assertEqual(args["--levels"], "3") + + def test_balsheet_with_levels_option(self): + argv = ["balsheet", "--levels=2"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + self.assertEqual(args["--levels"], "2") + + def test_balsheet_with_date_default(self): + argv = ["balsheet"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + self.assertEqual(args["--date"], "today") + + def test_balsheet_with_date_option(self): + argv = ["balsheet", "--date=2021-12-01"] + + args = docopt(cli.__doc__, argv=argv) + + self.assertTrue(args["balsheet"]) + self.assertEqual(args["--date"], "2021-12-01")