diff --git a/.github/workflows/pr_test.yaml b/.github/workflows/pr_test.yaml new file mode 100644 index 0000000..c182a80 --- /dev/null +++ b/.github/workflows/pr_test.yaml @@ -0,0 +1,48 @@ +name: Tests +on: + push: + branches: [pipfile-experiment] + tags: ['*'] + pull_request: + branches: [pipfile-experiment] + types: [opened, synchronize, reopened, closed] + +jobs: + build: + runs-on: ubuntu-latest + timeout-minutes: 5 + strategy: + matrix: + python-version: ["3.9","3.10","3.11"] + steps: + - uses: actions/checkout@v4 + - name: Install Python, pipenv and Pipfile packages + uses: kojoru/prepare-pipenv@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Turn on 'editable' mode + run: | + pipenv install -e . + - name: Test with pytest + run: | + pipenv install pytest + pipenv --venv + pipenv run python -m pytest + deliver: + if: github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/') + needs: [build] + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@v4 + - name: Install Python, pipenv and Pipfile packages + uses: kojoru/prepare-pipenv@v1 + - name: Build package + run: | + pipenv install build + pipenv run python -m build . + - name: Publish to PyPI test server + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{ secrets.PYPI_API_TOKEN }} + repository-url: https://upload.pypi.org/legacy/ diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..2fe7f57 --- /dev/null +++ b/Pipfile @@ -0,0 +1,17 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] + +[dev-packages] +pytest = "*" +build = "*" +twine = "*" + +[requires] +python_version = "3.9" + +[scripts] +snacktime = "python -m snacktime" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..88d604a --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,375 @@ +{ + "_meta": { + "hash": { + "sha256": "5fc24172ffa2e2febe7d5c3e453edbbae7a8933fa625d96c07ab624f10146c4c" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.14" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": {}, + "develop": { + "build": { + "hashes": [ + "sha256:698edd0ea270bde950f53aed21f3a0135672206f3911e0176261a31e0e07b397", + "sha256:7145f0b5061ba90a1500d60bd1b13ca0a8a4cebdd0cc16ed8adf1c0e739f43b4" + ], + "index": "pypi", + "markers": "python_version >= '3.9'", + "version": "==1.3.0" + }, + "certifi": { + "hashes": [ + "sha256:0f212c2744a9bb6de0c56639a6f68afe01ecd92d91f14ae897c4fe7bbeeef0de", + "sha256:47c09d31ccf2acf0be3f701ea53595ee7e0b8fa08801c6624be771df09ae7b43" + ], + "markers": "python_version >= '3.7'", + "version": "==2025.10.5" + }, + "charset-normalizer": { + "hashes": [ + "sha256:027f6de494925c0ab2a55eab46ae5129951638a49a34d87f4c3eda90f696b4ad", + "sha256:077fbb858e903c73f6c9db43374fd213b0b6a778106bc7032446a8e8b5b38b93", + "sha256:0a98e6759f854bd25a58a73fa88833fba3b7c491169f86ce1180c948ab3fd394", + "sha256:0d3d8f15c07f86e9ff82319b3d9ef6f4bf907608f53fe9d92b28ea9ae3d1fd89", + "sha256:0f04b14ffe5fdc8c4933862d8306109a2c51e0704acfa35d51598eb45a1e89fc", + "sha256:11d694519d7f29d6cd09f6ac70028dba10f92f6cdd059096db198c283794ac86", + "sha256:194f08cbb32dc406d6e1aea671a68be0823673db2832b38405deba2fb0d88f63", + "sha256:1bee1e43c28aa63cb16e5c14e582580546b08e535299b8b6158a7c9c768a1f3d", + "sha256:21d142cc6c0ec30d2efee5068ca36c128a30b0f2c53c1c07bd78cb6bc1d3be5f", + "sha256:2437418e20515acec67d86e12bf70056a33abdacb5cb1655042f6538d6b085a8", + "sha256:244bfb999c71b35de57821b8ea746b24e863398194a4014e4c76adc2bbdfeff0", + "sha256:2677acec1a2f8ef614c6888b5b4ae4060cc184174a938ed4e8ef690e15d3e505", + "sha256:277e970e750505ed74c832b4bf75dac7476262ee2a013f5574dd49075879e161", + "sha256:2aaba3b0819274cc41757a1da876f810a3e4d7b6eb25699253a4effef9e8e4af", + "sha256:2b7d8f6c26245217bd2ad053761201e9f9680f8ce52f0fcd8d0755aeae5b2152", + "sha256:2c9d3c380143a1fedbff95a312aa798578371eb29da42106a29019368a475318", + "sha256:3162d5d8ce1bb98dd51af660f2121c55d0fa541b46dff7bb9b9f86ea1d87de72", + "sha256:31fd66405eaf47bb62e8cd575dc621c56c668f27d46a61d975a249930dd5e2a4", + "sha256:362d61fd13843997c1c446760ef36f240cf81d3ebf74ac62652aebaf7838561e", + "sha256:376bec83a63b8021bb5c8ea75e21c4ccb86e7e45ca4eb81146091b56599b80c3", + "sha256:44c2a8734b333e0578090c4cd6b16f275e07aa6614ca8715e6c038e865e70576", + "sha256:47cc91b2f4dd2833fddaedd2893006b0106129d4b94fdb6af1f4ce5a9965577c", + "sha256:4902828217069c3c5c71094537a8e623f5d097858ac6ca8252f7b4d10b7560f1", + "sha256:4bd5d4137d500351a30687c2d3971758aac9a19208fc110ccb9d7188fbe709e8", + "sha256:4fe7859a4e3e8457458e2ff592f15ccb02f3da787fcd31e0183879c3ad4692a1", + "sha256:542d2cee80be6f80247095cc36c418f7bddd14f4a6de45af91dfad36d817bba2", + "sha256:554af85e960429cf30784dd47447d5125aaa3b99a6f0683589dbd27e2f45da44", + "sha256:5833d2c39d8896e4e19b689ffc198f08ea58116bee26dea51e362ecc7cd3ed26", + "sha256:5947809c8a2417be3267efc979c47d76a079758166f7d43ef5ae8e9f92751f88", + "sha256:5ae497466c7901d54b639cf42d5b8c1b6a4fead55215500d2f486d34db48d016", + "sha256:5bd2293095d766545ec1a8f612559f6b40abc0eb18bb2f5d1171872d34036ede", + "sha256:5bfbb1b9acf3334612667b61bd3002196fe2a1eb4dd74d247e0f2a4d50ec9bbf", + "sha256:5cb4d72eea50c8868f5288b7f7f33ed276118325c1dfd3957089f6b519e1382a", + "sha256:5dbe56a36425d26d6cfb40ce79c314a2e4dd6211d51d6d2191c00bed34f354cc", + "sha256:5f819d5fe9234f9f82d75bdfa9aef3a3d72c4d24a6e57aeaebba32a704553aa0", + "sha256:64b55f9dce520635f018f907ff1b0df1fdc31f2795a922fb49dd14fbcdf48c84", + "sha256:6515f3182dbe4ea06ced2d9e8666d97b46ef4c75e326b79bb624110f122551db", + "sha256:65e2befcd84bc6f37095f5961e68a6f077bf44946771354a28ad434c2cce0ae1", + "sha256:6aee717dcfead04c6eb1ce3bd29ac1e22663cdea57f943c87d1eab9a025438d7", + "sha256:6b39f987ae8ccdf0d2642338faf2abb1862340facc796048b604ef14919e55ed", + "sha256:6e1fcf0720908f200cd21aa4e6750a48ff6ce4afe7ff5a79a90d5ed8a08296f8", + "sha256:74018750915ee7ad843a774364e13a3db91682f26142baddf775342c3f5b1133", + "sha256:74664978bb272435107de04e36db5a9735e78232b85b77d45cfb38f758efd33e", + "sha256:74bb723680f9f7a6234dcf67aea57e708ec1fbdf5699fb91dfd6f511b0a320ef", + "sha256:752944c7ffbfdd10c074dc58ec2d5a8a4cd9493b314d367c14d24c17684ddd14", + "sha256:778d2e08eda00f4256d7f672ca9fef386071c9202f5e4607920b86d7803387f2", + "sha256:780236ac706e66881f3b7f2f32dfe90507a09e67d1d454c762cf642e6e1586e0", + "sha256:798d75d81754988d2565bff1b97ba5a44411867c0cf32b77a7e8f8d84796b10d", + "sha256:799a7a5e4fb2d5898c60b640fd4981d6a25f1c11790935a44ce38c54e985f828", + "sha256:7a32c560861a02ff789ad905a2fe94e3f840803362c84fecf1851cb4cf3dc37f", + "sha256:7c308f7e26e4363d79df40ca5b2be1c6ba9f02bdbccfed5abddb7859a6ce72cf", + "sha256:7fa17817dc5625de8a027cb8b26d9fefa3ea28c8253929b8d6649e705d2835b6", + "sha256:81d5eb2a312700f4ecaa977a8235b634ce853200e828fbadf3a9c50bab278328", + "sha256:82004af6c302b5d3ab2cfc4cc5f29db16123b1a8417f2e25f9066f91d4411090", + "sha256:837c2ce8c5a65a2035be9b3569c684358dfbf109fd3b6969630a87535495ceaa", + "sha256:840c25fb618a231545cbab0564a799f101b63b9901f2569faecd6b222ac72381", + "sha256:8a6562c3700cce886c5be75ade4a5db4214fda19fede41d9792d100288d8f94c", + "sha256:8af65f14dc14a79b924524b1e7fffe304517b2bff5a58bf64f30b98bbc5079eb", + "sha256:8ef3c867360f88ac904fd3f5e1f902f13307af9052646963ee08ff4f131adafc", + "sha256:94537985111c35f28720e43603b8e7b43a6ecfb2ce1d3058bbe955b73404e21a", + "sha256:99ae2cffebb06e6c22bdc25801d7b30f503cc87dbd283479e7b606f70aff57ec", + "sha256:9a26f18905b8dd5d685d6d07b0cdf98a79f3c7a918906af7cc143ea2e164c8bc", + "sha256:9b35f4c90079ff2e2edc5b26c0c77925e5d2d255c42c74fdb70fb49b172726ac", + "sha256:9cd98cdc06614a2f768d2b7286d66805f94c48cde050acdbbb7db2600ab3197e", + "sha256:9d1bb833febdff5c8927f922386db610b49db6e0d4f4ee29601d71e7c2694313", + "sha256:9f7fcd74d410a36883701fafa2482a6af2ff5ba96b9a620e9e0721e28ead5569", + "sha256:a59cb51917aa591b1c4e6a43c132f0cdc3c76dbad6155df4e28ee626cc77a0a3", + "sha256:a61900df84c667873b292c3de315a786dd8dac506704dea57bc957bd31e22c7d", + "sha256:a79cfe37875f822425b89a82333404539ae63dbdddf97f84dcbc3d339aae9525", + "sha256:a8a8b89589086a25749f471e6a900d3f662d1d3b6e2e59dcecf787b1cc3a1894", + "sha256:a8bf8d0f749c5757af2142fe7903a9df1d2e8aa3841559b2bad34b08d0e2bcf3", + "sha256:a9768c477b9d7bd54bc0c86dbaebdec6f03306675526c9927c0e8a04e8f94af9", + "sha256:ac1c4a689edcc530fc9d9aa11f5774b9e2f33f9a0c6a57864e90908f5208d30a", + "sha256:af2d8c67d8e573d6de5bc30cdb27e9b95e49115cd9baad5ddbd1a6207aaa82a9", + "sha256:b435cba5f4f750aa6c0a0d92c541fb79f69a387c91e61f1795227e4ed9cece14", + "sha256:b5b290ccc2a263e8d185130284f8501e3e36c5e02750fc6b6bdeb2e9e96f1e25", + "sha256:b5d84d37db046c5ca74ee7bb47dd6cbc13f80665fdde3e8040bdd3fb015ecb50", + "sha256:b7cf1017d601aa35e6bb650b6ad28652c9cd78ee6caff19f3c28d03e1c80acbf", + "sha256:bc7637e2f80d8530ee4a78e878bce464f70087ce73cf7c1caf142416923b98f1", + "sha256:c0463276121fdee9c49b98908b3a89c39be45d86d1dbaa22957e38f6321d4ce3", + "sha256:c4ef880e27901b6cc782f1b95f82da9313c0eb95c3af699103088fa0ac3ce9ac", + "sha256:c8ae8a0f02f57a6e61203a31428fa1d677cbe50c93622b4149d5c0f319c1d19e", + "sha256:ca5862d5b3928c4940729dacc329aa9102900382fea192fc5e52eb69d6093815", + "sha256:cb01158d8b88ee68f15949894ccc6712278243d95f344770fa7593fa2d94410c", + "sha256:cb6254dc36b47a990e59e1068afacdcd02958bdcce30bb50cc1700a8b9d624a6", + "sha256:cc00f04ed596e9dc0da42ed17ac5e596c6ccba999ba6bd92b0e0aef2f170f2d6", + "sha256:cd09d08005f958f370f539f186d10aec3377d55b9eeb0d796025d4886119d76e", + "sha256:cd4b7ca9984e5e7985c12bc60a6f173f3c958eae74f3ef6624bb6b26e2abbae4", + "sha256:ce8a0633f41a967713a59c4139d29110c07e826d131a316b50ce11b1d79b4f84", + "sha256:cead0978fc57397645f12578bfd2d5ea9138ea0fac82b2f63f7f7c6877986a69", + "sha256:d055ec1e26e441f6187acf818b73564e6e6282709e9bcb5b63f5b23068356a15", + "sha256:d1f13550535ad8cff21b8d757a3257963e951d96e20ec82ab44bc64aeb62a191", + "sha256:d9c7f57c3d666a53421049053eaacdd14bbd0a528e2186fcb2e672effd053bb0", + "sha256:d9e45d7faa48ee908174d8fe84854479ef838fc6a705c9315372eacbc2f02897", + "sha256:da3326d9e65ef63a817ecbcc0df6e94463713b754fe293eaa03da99befb9a5bd", + "sha256:de00632ca48df9daf77a2c65a484531649261ec9f25489917f09e455cb09ddb2", + "sha256:e1f185f86a6f3403aa2420e815904c67b2f9ebc443f045edd0de921108345794", + "sha256:e824f1492727fa856dd6eda4f7cee25f8518a12f3c4a56a74e8095695089cf6d", + "sha256:e912091979546adf63357d7e2ccff9b44f026c075aeaf25a52d0e95ad2281074", + "sha256:eaabd426fe94daf8fd157c32e571c85cb12e66692f15516a83a03264b08d06c3", + "sha256:ebf3e58c7ec8a8bed6d66a75d7fb37b55e5015b03ceae72a8e7c74495551e224", + "sha256:ecaae4149d99b1c9e7b88bb03e3221956f68fd6d50be2ef061b2381b61d20838", + "sha256:eecbc200c7fd5ddb9a7f16c7decb07b566c29fa2161a16cf67b8d068bd21690a", + "sha256:f155a433c2ec037d4e8df17d18922c3a0d9b3232a396690f17175d2946f0218d", + "sha256:f1e34719c6ed0b92f418c7c780480b26b5d9c50349e9a9af7d76bf757530350d", + "sha256:f34be2938726fc13801220747472850852fe6b1ea75869a048d6f896838c896f", + "sha256:f820802628d2694cb7e56db99213f930856014862f3fd943d290ea8438d07ca8", + "sha256:f8bf04158c6b607d747e93949aa60618b61312fe647a6369f88ce2ff16043490", + "sha256:f8e160feb2aed042cd657a72acc0b481212ed28b1b9a95c0cee1621b524e1966", + "sha256:f9d332f8c2a2fcbffe1378594431458ddbef721c1769d78e2cbc06280d8155f9", + "sha256:fa09f53c465e532f4d3db095e0c55b615f010ad81803d383195b6b5ca6cbf5f3", + "sha256:faa3a41b2b66b6e50f84ae4a68c64fcd0c44355741c6374813a800cd6695db9e", + "sha256:fd44c878ea55ba351104cb93cc85e74916eb8fa440ca7903e57575e97394f608" + ], + "markers": "python_version >= '3.7'", + "version": "==3.4.4" + }, + "docutils": { + "hashes": [ + "sha256:9fdb771707c8784c8f2728b67cb2c691305933d68137ef95a75db5f4dfbc213d", + "sha256:b0e98d679283fc3bb0ead8a5da7f501baa632654e7056e9c5846842213d674d8" + ], + "markers": "python_version >= '3.9'", + "version": "==0.22.2" + }, + "id": { + "hashes": [ + "sha256:292cb8a49eacbbdbce97244f47a97b4c62540169c976552e497fd57df0734c1d", + "sha256:f1434e1cef91f2cbb8a4ec64663d5a23b9ed43ef44c4c957d02583d61714c658" + ], + "markers": "python_version >= '3.8'", + "version": "==1.5.0" + }, + "idna": { + "hashes": [ + "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea", + "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902" + ], + "markers": "python_version >= '3.8'", + "version": "==3.11" + }, + "iniconfig": { + "hashes": [ + "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", + "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12" + ], + "markers": "python_version >= '3.10'", + "version": "==2.3.0" + }, + "jaraco.classes": { + "hashes": [ + "sha256:47a024b51d0239c0dd8c8540c6c7f484be3b8fcf0b2d85c13825780d3b3f3acd", + "sha256:f662826b6bed8cace05e7ff873ce0f9283b5c924470fe664fff1c2f00f581790" + ], + "markers": "python_version >= '3.8'", + "version": "==3.4.0" + }, + "jaraco.context": { + "hashes": [ + "sha256:9bae4ea555cf0b14938dc0aee7c9f32ed303aa20a3b73e7dc80111628792d1b3", + "sha256:f797fc481b490edb305122c9181830a3a5b76d84ef6d1aef2fb9b47ab956f9e4" + ], + "markers": "python_version >= '3.8'", + "version": "==6.0.1" + }, + "jaraco.functools": { + "hashes": [ + "sha256:227ff8ed6f7b8f62c56deff101545fa7543cf2c8e7b82a7c2116e672f29c26e8", + "sha256:cfd13ad0dd2c47a3600b439ef72d8615d482cedcff1632930d6f28924d92f294" + ], + "markers": "python_version >= '3.9'", + "version": "==4.3.0" + }, + "keyring": { + "hashes": [ + "sha256:0b39998aa941431eb3d9b0d4b2460bc773b9df6fed7621c2dfb291a7e0187a66", + "sha256:552a3f7af126ece7ed5c89753650eec89c7eaae8617d0aa4d9ad2b75111266bd" + ], + "markers": "python_version >= '3.9'", + "version": "==25.6.0" + }, + "markdown-it-py": { + "hashes": [ + "sha256:87327c59b172c5011896038353a81343b6754500a08cd7a4973bb48c6d578147", + "sha256:cb0a2b4aa34f932c007117b194e945bd74e0ec24133ceb5bac59009cda1cb9f3" + ], + "markers": "python_version >= '3.10'", + "version": "==4.0.0" + }, + "mdurl": { + "hashes": [ + "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", + "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba" + ], + "markers": "python_version >= '3.7'", + "version": "==0.1.2" + }, + "more-itertools": { + "hashes": [ + "sha256:52d4362373dcf7c52546bc4af9a86ee7c4579df9a8dc268be0a2f949d376cc9b", + "sha256:f638ddf8a1a0d134181275fb5d58b086ead7c6a72429ad725c67503f13ba30bd" + ], + "markers": "python_version >= '3.9'", + "version": "==10.8.0" + }, + "nh3": { + "hashes": [ + "sha256:019ecbd007536b67fdf76fab411b648fb64e2257ca3262ec80c3425c24028c80", + "sha256:03d617e5c8aa7331bd2659c654e021caf9bba704b109e7b2b28b039a00949fe5", + "sha256:0dca4365db62b2d71ff1620ee4f800c4729849906c5dd504ee1a7b2389558e31", + "sha256:0fe7ee035dd7b2290715baf29cb27167dddd2ff70ea7d052c958dbd80d323c99", + "sha256:13398e676a14d6233f372c75f52d5ae74f98210172991f7a3142a736bd92b131", + "sha256:169db03df90da63286e0560ea0efa9b6f3b59844a9735514a1d47e6bb2c8c61b", + "sha256:1710f3901cd6440ca92494ba2eb6dc260f829fa8d9196b659fa10de825610ce0", + "sha256:1f9ba555a797dbdcd844b89523f29cdc90973d8bd2e836ea6b962cf567cadd93", + "sha256:2ab70e8c6c7d2ce953d2a58102eefa90c2d0a5ed7aa40c7e29a487bc5e613131", + "sha256:2c9850041b77a9147d6bbd6dbbf13eeec7009eb60b44e83f07fcb2910075bf9b", + "sha256:403c11563e50b915d0efdb622866d1d9e4506bce590ef7da57789bf71dd148b5", + "sha256:45c953e57028c31d473d6b648552d9cab1efe20a42ad139d78e11d8f42a36130", + "sha256:562da3dca7a17f9077593214a9781a94b8d76de4f158f8c895e62f09573945fe", + "sha256:6d66f41672eb4060cf87c037f760bdbc6847852ca9ef8e9c5a5da18f090abf87", + "sha256:7064ccf5ace75825bd7bf57859daaaf16ed28660c1c6b306b649a9eda4b54b1e", + "sha256:72d67c25a84579f4a432c065e8b4274e53b7cf1df8f792cf846abfe2c3090866", + "sha256:7bb18403f02b655a1bbe4e3a4696c2ae1d6ae8f5991f7cacb684b1ae27e6c9f7", + "sha256:91e9b001101fb4500a2aafe3e7c92928d85242d38bf5ac0aba0b7480da0a4cd6", + "sha256:a40202fd58e49129764f025bbaae77028e420f1d5b3c8e6f6fd3a6490d513868", + "sha256:c8745454cdd28bbbc90861b80a0111a195b0e3961b9fa2e672be89eb199fa5d8", + "sha256:cf5964d54edd405e68583114a7cba929468bcd7db5e676ae38ee954de1cfc104", + "sha256:d18957a90806d943d141cc5e4a0fefa1d77cf0d7a156878bf9a66eed52c9cc7d", + "sha256:dce4248edc427c9b79261f3e6e2b3ecbdd9b88c267012168b4a7b3fc6fd41d13", + "sha256:f2f55c4d2d5a207e74eefe4d828067bbb01300e06e2a7436142f915c5928de07", + "sha256:f394759a06df8b685a4ebfb1874fb67a9cbfd58c64fc5ed587a663c0e63ec376", + "sha256:f97f8b25cb2681d25e2338148159447e4d689aafdccfcf19e61ff7db3905768a" + ], + "markers": "python_version >= '3.8'", + "version": "==0.3.2" + }, + "packaging": { + "hashes": [ + "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", + "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f" + ], + "markers": "python_version >= '3.8'", + "version": "==25.0" + }, + "pluggy": { + "hashes": [ + "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", + "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746" + ], + "markers": "python_version >= '3.9'", + "version": "==1.6.0" + }, + "pygments": { + "hashes": [ + "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887", + "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b" + ], + "markers": "python_version >= '3.8'", + "version": "==2.19.2" + }, + "pyproject-hooks": { + "hashes": [ + "sha256:1e859bd5c40fae9448642dd871adf459e5e2084186e8d2c2a79a824c970da1f8", + "sha256:9e5c6bfa8dcc30091c74b0cf803c81fdd29d94f01992a7707bc97babb1141913" + ], + "markers": "python_version >= '3.7'", + "version": "==1.2.0" + }, + "pytest": { + "hashes": [ + "sha256:86c0d0b93306b961d58d62a4db4879f27fe25513d4b969df351abdddb3c30e01", + "sha256:872f880de3fc3a5bdc88a11b39c9710c3497a547cfa9320bc3c5e62fbf272e79" + ], + "index": "pypi", + "markers": "python_version >= '3.9'", + "version": "==8.4.2" + }, + "readme-renderer": { + "hashes": [ + "sha256:2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151", + "sha256:8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1" + ], + "markers": "python_version >= '3.9'", + "version": "==44.0" + }, + "requests": { + "hashes": [ + "sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6", + "sha256:dbba0bac56e100853db0ea71b82b4dfd5fe2bf6d3754a8893c3af500cec7d7cf" + ], + "markers": "python_version >= '3.9'", + "version": "==2.32.5" + }, + "requests-toolbelt": { + "hashes": [ + "sha256:7681a0a3d047012b5bdc0ee37d7f8f07ebe76ab08caeccfc3921ce23c88d5bc6", + "sha256:cccfdd665f0a24fcf4726e690f65639d272bb0637b9b92dfd91a5568ccf6bd06" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.0.0" + }, + "rfc3986": { + "hashes": [ + "sha256:50b1502b60e289cb37883f3dfd34532b8873c7de9f49bb546641ce9cbd256ebd", + "sha256:97aacf9dbd4bfd829baad6e6309fa6573aaf1be3f6fa735c8ab05e46cecb261c" + ], + "markers": "python_version >= '3.7'", + "version": "==2.0.0" + }, + "rich": { + "hashes": [ + "sha256:73ff50c7c0c1c77c8243079283f4edb376f0f6442433aecb8ce7e6d0b92d1fe4", + "sha256:76bc51fe2e57d2b1be1f96c524b890b816e334ab4c1e45888799bfaab0021edd" + ], + "markers": "python_full_version >= '3.8.0'", + "version": "==14.2.0" + }, + "twine": { + "hashes": [ + "sha256:418ebf08ccda9a8caaebe414433b0ba5e25eb5e4a927667122fbe8f829f985d8", + "sha256:e5ed0d2fd70c9959770dce51c8f39c8945c574e18173a7b81802dab51b4b75cf" + ], + "index": "pypi", + "markers": "python_version >= '3.9'", + "version": "==6.2.0" + }, + "urllib3": { + "hashes": [ + "sha256:3fc47733c7e419d4bc3f6b3dc2b4f890bb743906a30d56ba4a5bfa4bbff92760", + "sha256:e6b01673c0fa6a13e374b50871808eb3bf7046c4b125b216f6bf1cc604cff0dc" + ], + "markers": "python_version >= '3.9'", + "version": "==2.5.0" + } + } +} diff --git a/README.md b/README.md index 6022e0e..5f2f11a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,148 @@ -# Python Package Exercise +# πŸ₯— snacktime -An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details. +**Build & Tests** +Python 3.09 ![Python 3.09](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.09) +Python 3.10 ![Python 3.10](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.10) +Python 3.11 ![Python 3.11](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.11) + + + +A lightweight and fun Python package that helps you pick a **random snack**, **vegetable**, **sweet treat**, or even generate a **simple salad recipe**. +Originally created as part of the Software Engineering Fall 2025 team project β€” this package demonstrates Python packaging, publishing, and CI automation. + +--- + +## πŸ“¦ PyPI Project + +πŸ”— **Link:** [https://pypi.org/project/snacktime/](https://pypi.org/project/snacktime/) + +--- + +## πŸš€ Installation + +You can install directly from PyPI using pip: + +```bash +pip install snacktime +``` + +--- + +## 🧩 Usage + +Once installed, simply import and call any of the available functions: + +```python +import snacktime + +print(snacktime.random_snack()) +print(snacktime.random_vegetable()) +print(snacktime.random_treat()) +print(snacktime.recipe_salad(serves=2, dressing="balsamic")) +``` + +### 🧾 Example Output + +```bash +granola bar +spinach +cupcake + +Simple Green Salad +Serves: 2 + +Ingredients +----------- +- 4 cups mixed greens +- 2 cups chopped vegetables (e.g., cucumber, tomato, carrot) +- 4 tbsp nuts or seeds (optional) +- Salt & pepper to taste +- Dressing: 4 tbsp olive oil, 2 tbsp balsamic vinegar, pinch of salt + +Steps +----- +1) Toss greens and chopped veggies in a bowl. +2) Whisk dressing separately, then drizzle over salad. +3) Sprinkle nuts/seeds. Season with salt & pepper. Toss and serve. +``` + + +Or, if preferred, snacktime can be called from the command line once installed: +```bash +$ pipenv run snacktime snack +pretzels +$ pipenv run snacktime treat +churro +$ pipenv run snacktime vegetable +spinach +$ pipenv run snacktime recipe +Simple Green Salad +Serves: 2 + +Ingredients +---------- +- 4 cups mixed greens +- 2 cup chopped vegetables (e.g., cucumber, tomato, carrot) +- 4 tbsp nuts or seeds (optional) +- Salt & pepper to taste +- Dressing: 4 tbsp olive oil, 2 tbsp balsamic vinegar, pinch of salt + +Steps +----- +1) Toss greens and chopped veggies in a bowl. +2) Whisk dressing separately, then drizzle over salad. +3) Sprinkle nuts/seeds. Season with salt & pepper. Toss and serve. +``` + +Make sure not to snack too much! + + +--- + +## ✨ Features + +- 🍎 **`random_snack()`** β€” pick a random healthy or quick snack +- πŸ₯¦ **`random_vegetable()`** β€” choose a random vegetable +- 🍩 **`random_treat()`** β€” get a random dessert idea +- πŸ₯— **`recipe_salad()`** β€” generate a simple, customizable salad recipe + +--- + +## πŸ‘₯ Team Solace + +- **Member**: [funfigwat](https://github.com/funfig16), [qiexian-mf](https://github.com/qiexian-mf), [ems9856-lgtm](https://github.com/ems9856-lgtm), [hanqigui](https://github.com/hanqigui), [jawarbx](https://github.com/jawarbx) + +--- + +## 🧠 Notes + +- Tested with **Python 3.9+** on macOS and Linux. +- All random functions can be made deterministic with a `seed` argument. + ```python + snacktime.random_snack(seed=42) + ``` +- Supports CLI and programmatic use. + +--- + +## πŸ§‘β€πŸ’» Project Details + +| Field | Description | +|-------|-------------| +| **Package Name** | `snacktime` | +| **Author** | Team Solace | +| **License** | GPL 3.0 | +| **Language** | Python 3.9+ | +| **PyPI Page** | [https://pypi.org/project/snacktime/](https://pypi.org/project/snacktime/) + +--- + +## πŸ₯³ Credits + +Developed by **Team Solace** for *Software Engineering (Fall 2025)* +as part of the Python Package exercise. +This project demonstrates collaboration, testing, automation, and packaging best practices. + +--- + +**Enjoy your snacks and code responsibly,thank you! πŸͺπŸ₯—πŸ«** diff --git a/examples/demo.py b/examples/demo.py new file mode 100644 index 0000000..c087a67 --- /dev/null +++ b/examples/demo.py @@ -0,0 +1,15 @@ +# examples/demo.py + +from snacktime import random_snack, random_treat, random_vegetable, recipe_salad + +def main(): + print("=== snacktime demo ===") + print("snack:", random_snack(seed=1)) + print("treat:", random_treat(seed=2)) + print("vegetable:", random_vegetable(seed=3)) + + print("\n--- salad recipe ---") + print(recipe_salad(serves=3, dressing="lemon")) + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..3555958 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,42 @@ +[build-system] +requires = ["setuptools>=68", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "snacktime" +version = "0.5.1" +description = "CLI that gives a random snack, a simple salad recipe, a random vegetable, or a sweet treat." +authors = [ + {name="Ezra Shapiro", email="ems9856@nyu.edu"}, + {name="Athena Luo", email="athenaluoxy@gmail.com"}, + {name="Jasir Nawar", email="jn2691@nyu.edu"}, + {name="Hanqi Gui", email="hg2542@nyu.edu"}, + {name="Kaiyuan Wu", email="wkyklmf@gmail.com"} +] + +maintainers = [ + {name="Ezra Shapiro", email="ems9856@nyu.edu"}, + {name="Athena Luo", email="athenaluoxy@gmail.com"}, + {name="Jasir Nawar", email="jn2691@nyu.edu"}, + {name="Hanqi Gui", email="hg2542@nyu.edu"}, + {name="Kaiyuan Wu", email="wkyklmf@gmail.com"} +] + +license = { file = "LICENSE" } +readme = "README.md" +requires-python = ">=3.9" + +[project.scripts] +snacktime = "snacktime.__main__:main" + +[project.optional-dependencies] +dev = ['pytest'] + +[project.urls] +"Homepage" = "https://github.com/swe-students-fall2025/3-python-package-team_solace" +"Repository" = "https://github.com/swe-students-fall2025/3-python-package-team_solace.git" +"Bug Tracker" = "https://github.com/swe-students-fall2025/3-python-package-team_solace/issues" + +[tool.setuptools.packages.find] +where = ["."] +include = ["snacktime*"] diff --git a/snacktime/__init__.py b/snacktime/__init__.py new file mode 100644 index 0000000..753c916 --- /dev/null +++ b/snacktime/__init__.py @@ -0,0 +1,10 @@ +__version__ = "0.2.0" + +from .core import ( + random_snack, + random_vegetable, + random_treat, + recipe_salad, +) + +__all__ = ["random_snack", "random_vegetable", "random_treat", "recipe_salad"] \ No newline at end of file diff --git a/snacktime/__main__.py b/snacktime/__main__.py new file mode 100644 index 0000000..3f62ccf --- /dev/null +++ b/snacktime/__main__.py @@ -0,0 +1,55 @@ +import sys +from . import random_snack, random_vegetable, random_treat, recipe_salad, __version__ + +USAGE = """\ +snacktime v{v} + +Usage: + snacktime snack # random snack + snacktime recipe [--serves N] [--dressing NAME] + snacktime vegetable [--seed N] # random vegetable + snacktime treat [--seed N] # random sweet treat + +Options: + --seed N Deterministic selection for snack/vegetable/treat (default: none) + --serves N Servings for the salad recipe (default: 2) + --dressing NAME lemon | balsamic | olive (default: balsamic) +""" + +def main(argv=None): + argv = list(sys.argv[1:] if argv is None else argv) + if not argv: + print(USAGE.format(v=__version__)) + return 0 + + cmd = argv[0].lower().strip() + args = argv[1:] + + # parse simple flags + def read_flag(name, cast=int, default=None): + if name in args: + i = args.index(name) + try: + return cast(args[i+1]) + except Exception: + raise SystemExit(f"Invalid value for {name}") + return default + + seed = read_flag("--seed", int, None) + serves = read_flag("--serves", int, 2) + dressing = read_flag("--dressing", str, "balsamic") + + if cmd == "snack": + print(random_snack(seed=seed)); return 0 + if cmd == "vegetable": + print(random_vegetable(seed=seed)); return 0 + if cmd == "treat": + print(random_treat(seed=seed)); return 0 + if cmd == "recipe": + print(recipe_salad(serves=serves, dressing=dressing)); return 0 + + print(USAGE.format(v=__version__)) + return 1 + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/snacktime/core.py b/snacktime/core.py new file mode 100644 index 0000000..db4b002 --- /dev/null +++ b/snacktime/core.py @@ -0,0 +1,83 @@ +from typing import Optional, Sequence +import random +import textwrap + +def _normalize_seed(seed: Optional[int]) -> Optional[int]: + """Accept only int or None; raise on other types.""" + if seed is None: + return None + if isinstance(seed, bool) or not isinstance(seed, int): + raise TypeError("seed must be an int or None") + return seed + +_SNACKS: Sequence[str] = ( + "pretzels", "popcorn", "granola bar", "apple slices", "yogurt cup", + "cheese & crackers", "trail mix", "rice cakes", "hummus & pita" +) + +_VEGETABLES: Sequence[str] = ( + "carrot", "cucumber", "spinach", "kale", "broccoli", + "bell pepper", "tomato", "celery", "edamame" +) + +_TREATS: Sequence[str] = ( + "chocolate chip cookie", "brownie bite", "gummy bears", + "ice cream scoop", "cupcake", "churro", "donut hole" +) + +def random_snack(seed: Optional[int] = None) -> str: + seed = _normalize_seed(seed) + rng = random.Random(seed) if seed is not None else random.Random() + return rng.choice(_SNACKS) + +def random_vegetable(seed: Optional[int] = None) -> str: + seed = _normalize_seed(seed) + rng = random.Random(seed) if seed is not None else random.Random() + return rng.choice(_VEGETABLES) + +def random_treat(seed: Optional[int] = None) -> str: + seed = _normalize_seed(seed) + rng = random.Random(seed) if seed is not None else random.Random() + return rng.choice(_TREATS) + +def recipe_salad(serves: int = 1, dressing: str = "lemon") -> str: + """ + Return a simple salad recipe as a formatted string. + Args: + serves: number of servings (must be >= 1) + dressing: 'lemon' | 'balsamic' | 'olive' + """ + if serves < 1: + raise ValueError("serves must be >= 1") + dressing = dressing.lower().strip() + if dressing not in {"lemon", "balsamic", "olive"}: + raise ValueError("dressing must be 'lemon', 'balsamic', or 'olive'") + + base = textwrap.dedent(f""" + Simple Green Salad + Serves: {serves} + + Ingredients + ---------- + - {2*serves} cups mixed greens + - {serves} cup chopped vegetables (e.g., cucumber, tomato, carrot) + - {serves*2} tbsp nuts or seeds (optional) + - Salt & pepper to taste + """).strip() + + if dressing == "lemon": + d = f"- Dressing: {serves*2} tbsp olive oil, {serves} tbsp lemon juice, pinch of salt" + elif dressing == "balsamic": + d = f"- Dressing: {serves*2} tbsp olive oil, {serves} tbsp balsamic vinegar, pinch of salt" + else: # olive + d = f"- Dressing: {serves*2} tbsp olive oil, {serves} tsp red wine vinegar (optional), pinch of salt" + + steps = textwrap.dedent(""" + Steps + ----- + 1) Toss greens and chopped veggies in a bowl. + 2) Whisk dressing separately, then drizzle over salad. + 3) Sprinkle nuts/seeds. Season with salt & pepper. Toss and serve. + """).strip() + + return f"{base}\n{d}\n\n{steps}\n" diff --git a/tests/test_membership_list.py b/tests/test_membership_list.py new file mode 100644 index 0000000..6901c9d --- /dev/null +++ b/tests/test_membership_list.py @@ -0,0 +1,9 @@ +from snacktime.core import _SNACKS, _VEGETABLES, _TREATS +from snacktime import random_snack, random_vegetable, random_treat + +def test_random_outputs_are_from_defined_sets(): + assert random_snack(seed=3) in _SNACKS + assert random_vegetable(seed=4) in _VEGETABLES + assert random_treat(seed=5) in _TREATS + +#ensure pulled froom list created \ No newline at end of file diff --git a/tests/test_module_metadata.py b/tests/test_module_metadata.py new file mode 100644 index 0000000..a243676 --- /dev/null +++ b/tests/test_module_metadata.py @@ -0,0 +1,12 @@ +import re +import snacktime + +def test_version_semver_like(): + assert isinstance(snacktime.__version__, str) + assert re.match(r"^\d+\.\d+\.\d+$", snacktime.__version__) + +def test_all_exports(): + for name in ["random_snack", "random_vegetable", "random_treat", "recipe_salad"]: + assert name in snacktime.__all__ + +#semantic version expected \ No newline at end of file diff --git a/tests/test_public_seed_errors.py b/tests/test_public_seed_errors.py new file mode 100644 index 0000000..0181229 --- /dev/null +++ b/tests/test_public_seed_errors.py @@ -0,0 +1,12 @@ +import pytest +from snacktime import random_snack, random_vegetable, random_treat + +BAD_SEEDS = [True, False, 3.14, "1", object()] + +@pytest.mark.parametrize("func", [random_snack, random_vegetable, random_treat]) +@pytest.mark.parametrize("bad", BAD_SEEDS) +def test_public_random_functions_reject_bad_seed(func, bad): + with pytest.raises(TypeError): + func(seed=bad) + +#raise TypeError if non-int/non-None seed \ No newline at end of file diff --git a/tests/test_random_snack.py b/tests/test_random_snack.py new file mode 100644 index 0000000..afa4c23 --- /dev/null +++ b/tests/test_random_snack.py @@ -0,0 +1,15 @@ +import pytest +from snacktime import random_snack + +class Tests: + def test_random_snack_deterministic(self): + assert random_snack(seed=1) == random_snack(seed=1) + + def test_random_snack_membership(self): + s = random_snack(seed=2) + assert isinstance(s, str) and len(s) > 0 + + def test_random_snack_varies_with_seed(self): + seeds = range(10, 30) + values = [random_snack(seed=s) for s in seeds] + assert len(set(values)) > 1 diff --git a/tests/test_random_treat.py b/tests/test_random_treat.py new file mode 100644 index 0000000..d9c824e --- /dev/null +++ b/tests/test_random_treat.py @@ -0,0 +1,13 @@ +import pytest +from snacktime import random_treat + +class Tests: + def test_random_treat_deterministic(self): + assert random_treat(seed=20) == random_treat(seed=20), "Expected same result for same seed" + + def test_random_treat_is_string(self): + t = random_treat(seed=21) + assert isinstance(t, str) and len(t) > 0, "Expected nonempty string" + + def test_random_treat_varies_with_seed(self): + assert random_treat(seed=22) != random_treat(seed=23), "Expected different result for different seed" diff --git a/tests/test_random_vegetable.py b/tests/test_random_vegetable.py new file mode 100644 index 0000000..ff4ff14 --- /dev/null +++ b/tests/test_random_vegetable.py @@ -0,0 +1,13 @@ +import pytest +from snacktime import random_vegetable + +class Tests: + def test_random_vegetable_deterministic(self): + assert random_vegetable(seed=10) == random_vegetable(seed=10) + + def test_random_vegetable_is_string(self): + v = random_vegetable(seed=11) + assert isinstance(v, str) and len(v) > 0 + + def test_random_vegetable_varies_with_seed(self): + assert random_vegetable(seed=12) != random_vegetable(seed=13) diff --git a/tests/test_recipe_invalid_inputs.py b/tests/test_recipe_invalid_inputs.py new file mode 100644 index 0000000..98a0c30 --- /dev/null +++ b/tests/test_recipe_invalid_inputs.py @@ -0,0 +1,12 @@ +import pytest +from snacktime import recipe_salad + +def test_recipe_invalid_serves_raises_valueerror(): + with pytest.raises(ValueError): + recipe_salad(serves=0, dressing="lemon") + +def test_recipe_invalid_dressing_raises_valueerror(): + with pytest.raises(ValueError): + recipe_salad(serves=1, dressing="ranch") + +#reject invalid input values \ No newline at end of file diff --git a/tests/test_recipe_output_format.py b/tests/test_recipe_output_format.py new file mode 100644 index 0000000..c880b97 --- /dev/null +++ b/tests/test_recipe_output_format.py @@ -0,0 +1,12 @@ +from snacktime import recipe_salad + +def test_recipe_has_sections_and_trailing_newline(): + out = recipe_salad(serves=1, dressing="lemon") + assert "Simple Green Salad" in out + assert "Ingredients" in out and "Steps" in out + assert out.endswith("\n"), "Expect trailing newline for nice CLI printing" + for n in ("1)", "2)", "3)"): + assert n in out + + +#ensure formatted & readable recipe \ No newline at end of file diff --git a/tests/test_recipe_salad.py b/tests/test_recipe_salad.py new file mode 100644 index 0000000..6ab7d9a --- /dev/null +++ b/tests/test_recipe_salad.py @@ -0,0 +1,18 @@ +import pytest +from snacktime import recipe_salad + +class Tests: + def test_recipe_includes_serves_and_ingredients(self): + r = recipe_salad(serves=2, dressing="lemon") + assert "Serves: 2" in r + assert "Ingredients" in r + assert "Dressing" in r + + def test_recipe_bad_serves_raises(self): + with pytest.raises(ValueError): + recipe_salad(serves=0) + + def test_recipe_dressing_variants(self): + for d in ("lemon", "balsamic", "olive"): + out = recipe_salad(serves=1, dressing=d) + assert d in out.lower() diff --git a/tests/test_recipe_whitespace_capital.py b/tests/test_recipe_whitespace_capital.py new file mode 100644 index 0000000..e7f87a0 --- /dev/null +++ b/tests/test_recipe_whitespace_capital.py @@ -0,0 +1,14 @@ +import pytest +from snacktime import recipe_salad + +@pytest.mark.parametrize("txt,expected", [ + ("LEMON", "lemon"), + (" Lemon ", "lemon"), + ("bAlSaMiC", "balsamic"), + (" olive", "olive"), +]) +def test_dressing_accepts_case_and_whitespace(txt, expected): + out = recipe_salad(serves=2, dressing=txt) + assert expected in out.lower() + +#case insensitive \ No newline at end of file diff --git a/tests/test_seed_validation.py b/tests/test_seed_validation.py new file mode 100644 index 0000000..a4e1ea2 --- /dev/null +++ b/tests/test_seed_validation.py @@ -0,0 +1,22 @@ +import pytest +from snacktime.core import _normalize_seed +from snacktime import recipe_salad + +def test_seed_accepts_int_and_none(): + assert _normalize_seed(42) == 42 + assert _normalize_seed(None) is None + +@pytest.mark.parametrize("bad", [True, False, 3.14, "7", object()]) +def test_seed_rejects_others(bad): + with pytest.raises(TypeError): + _normalize_seed(bad) + +@pytest.mark.parametrize("n", [1, 2, 4]) +def test_recipe_quantities_scale(n): + out = recipe_salad(serves=n, dressing="lemon") + assert f"Serves: {n}" in out + assert f"- {2*n} cups mixed greens" in out + assert f"- {n} cup chopped vegetables" in out + assert f"- {2*n} tbsp nuts or seeds" in out + +#ormalize_seed should accept int/None & other types raise typeError; recpite quantiity follows serve argument \ No newline at end of file