Developer Notes⚓︎
Local Development⚓︎
git clone https://github.com/kyleking/calcipy.git
cd calcipy
poetry install --sync
poetry run calcipy-pack pack.install-extras
# See the available tasks
poetry run calcipy
# Or use a local 'run' file (so that 'calcipy' can be extended)
./run
# Run the default task list (lint, auto-format, test coverage, etc.)
./run main
# Make code changes and run specific tasks as needed:
./run lint.fix test
Publishing⚓︎
For testing, create an account on TestPyPi. Replace ... with the API token generated on TestPyPi or PyPi respectively
poetry config repositories.testpypi https://test.pypi.org/legacy/
poetry config pypi-token.testpypi ...
./run main pack.publish --to-test-pypi
# If you didn't configure a token, you will need to provide your username and password to publish
To publish to the real PyPi
poetry config pypi-token.pypi ...
./run release
# Or for a pre-release
./run release --suffix=rc
Current Status⚓︎
| File | Statements | Missing | Excluded | Coverage |
|---|---|---|---|---|
calcipy/__init__.py |
17 | 0 | 17 | 100.0% |
calcipy/can_skip.py |
17 | 1 | 0 | 89.3% |
calcipy/check_for_stale_packages/__init__.py |
4 | 2 | 0 | 50.0% |
calcipy/check_for_stale_packages/_check_for_stale_packages.py |
118 | 8 | 3 | 87.2% |
calcipy/cli.py |
37 | 1 | 36 | 93.3% |
calcipy/code_tag_collector/__init__.py |
4 | 2 | 0 | 50.0% |
calcipy/code_tag_collector/_collector.py |
143 | 2 | 0 | 94.0% |
calcipy/dot_dict/__init__.py |
4 | 2 | 0 | 50.0% |
calcipy/dot_dict/_dot_dict.py |
8 | 0 | 0 | 100.0% |
calcipy/experiments/__init__.py |
0 | 0 | 0 | 100.0% |
calcipy/experiments/bump_programmatically.py |
24 | 16 | 0 | 33.3% |
calcipy/experiments/check_duplicate_test_names.py |
36 | 0 | 2 | 95.0% |
calcipy/file_search.py |
38 | 0 | 2 | 91.8% |
calcipy/invoke_helpers.py |
30 | 2 | 0 | 81.8% |
calcipy/md_writer/__init__.py |
4 | 2 | 0 | 50.0% |
calcipy/md_writer/_writer.py |
95 | 6 | 0 | 88.9% |
calcipy/noxfile/__init__.py |
4 | 2 | 0 | 50.0% |
calcipy/noxfile/_noxfile.py |
48 | 2 | 32 | 83.8% |
calcipy/scripts.py |
5 | 0 | 35 | 100.0% |
calcipy/tasks/__init__.py |
0 | 0 | 0 | 100.0% |
calcipy/tasks/_invoke.py |
37 | 0 | 45 | 97.7% |
calcipy/tasks/all_tasks.py |
48 | 0 | 0 | 95.5% |
calcipy/tasks/cl.py |
28 | 5 | 0 | 75.0% |
calcipy/tasks/defaults.py |
20 | 0 | 0 | 89.3% |
calcipy/tasks/doc.py |
45 | 0 | 8 | 90.5% |
calcipy/tasks/executable_utils.py |
28 | 0 | 0 | 87.5% |
calcipy/tasks/lint.py |
58 | 1 | 0 | 84.1% |
calcipy/tasks/nox.py |
8 | 0 | 0 | 100.0% |
calcipy/tasks/pack.py |
42 | 10 | 0 | 65.6% |
calcipy/tasks/stale.py |
9 | 1 | 0 | 90.9% |
calcipy/tasks/tags.py |
18 | 1 | 0 | 91.7% |
calcipy/tasks/test.py |
45 | 1 | 2 | 89.2% |
calcipy/tasks/types.py |
20 | 0 | 0 | 89.3% |
| Totals | 1042 | 67 | 182 | 87.2% |
Generated on: 2024-04-18