diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..78a0238 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,42 @@ +name: CI / CD +on: + pull_request: + branches: pipfile-experiment +jobs: + build: + runs-on: ubuntu-latest + timeout-minutes: 5 + strategy: + matrix: + python-version: ["3.9", "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: + 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.TEST_PYPI_API_TOKEN }} + repository-url: https://test.pypi.org/legacy/ \ No newline at end of file diff --git a/.github/workflows/event-logger.yml b/.github/workflows/event-logger.yml index 31f231e..bf5f731 100644 --- a/.github/workflows/event-logger.yml +++ b/.github/workflows/event-logger.yml @@ -1,5 +1,5 @@ name: log github events -on: +on: push: branches: [main, master, pipfile-experiment] pull_request: diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..9ccb6d7 --- /dev/null +++ b/Pipfile @@ -0,0 +1,16 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +pytest = "*" +chatterpy = {file = ".", editable = true} + +[dev-packages] +pytest = "*" +build = "*" +twine = "*" + +[requires] +python_version = "3.12" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..cd4cc1b --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,422 @@ +{ + "_meta": { + "hash": { + "sha256": "1b13d5a983804281ff8b1670cab7d07b64f7a9c5d5fa35de78ccb20de9dc1a21" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.12" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "chatterpy": { + "editable": true, + "file": ".", + "markers": "python_version >= '3.11'" + }, + "iniconfig": { + "hashes": [ + "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", + "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12" + ], + "markers": "python_version >= '3.10'", + "version": "==2.3.0" + }, + "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" + }, + "pytest": { + "hashes": [ + "sha256:86c0d0b93306b961d58d62a4db4879f27fe25513d4b969df351abdddb3c30e01", + "sha256:872f880de3fc3a5bdc88a11b39c9710c3497a547cfa9320bc3c5e62fbf272e79" + ], + "index": "pypi", + "markers": "python_version >= '3.9'", + "version": "==8.4.2" + } + }, + "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..0332808 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,288 @@ -# Python Package Exercise +![CI / CD](https://github.com/swe-students-fall2025/3-python-package-team_mistral/actions/workflows/build.yaml/badge.svg) -An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details. + +# ChatterPy + +ChatterPy is a lighthearted Python package that helps spark **fun conversations** by giving you a random **fun fact**, **small talk question**, **compliment**, or even a **pickup line** for when things get quiet. + +## Group Members + +[Mahabub Alif](https://github.com/Alif-4) + +[Sydney Nadeau](https://github.com/sen5217) + +[Susan Wang](https://github.com/sw5556) + +[Aden Juda](https://github.com/yungsemitone) + +[Serena Wang](https://github.com/serena0615) + + +## Installation + +### For Users: Install via pip +```bash +pip install chatterpy +``` + +### For Contributors: Set Up Development Environment + +If you want to contribute to ChatterPy, follow these steps: + +1. **Clone the repository:** +```bash + git clone https://github.com/swe-students-fall2025/3-python-package-team_mistral.git + cd 3-python-package-team_mistral +``` + +2. **Install pipenv** (if you don't have it): +```bash + pip install pipenv +``` + +3. **Install dependencies:** +```bash + pipenv install --dev +``` + +4. **Activate the virtual environment:** +```bash + pipenv shell +``` + +5. **Run tests:** +```bash + pipenv run pytest +``` + +6. **Build the package:** +```bash + pipenv run python -m build +``` + +--- + +## Usage + +### Importing ChatterPy in Your Code + +After installing with `pip install chatterpy`, you can import and use any function: +```python +from chatterpy import fun_fact, smallTalk, pickUpLine, compliment, banter + +# Get a random fun fact +print(fun_fact()) + +# Get a fun fact from a specific category +print(fun_fact(category="science", rarity="rare")) + +# Get small talk - question +print(smallTalk(question=True)) + +# Get small talk - comment +print(smallTalk(question=False)) + +# Get a pickup line +print(pickUpLine(kind="poetic", name="Alex")) + +# Get a compliment +print(compliment(name="Jordan", intensity=2, style="classic", category="personality")) + +# Get playful banter +print(banter(intensity="mild", name="Sam")) +``` + +**See [example.py](src/example.py) for a complete interactive demonstration.** + +To run the example program: +```bash +python src/example.py +``` + +## Command-Line Interface + +### Using the CLI After Installation + +Once installed via pip, you can use ChatterPy from the command line, for example: + +```bash +chatterpy --smalltalk --comment +``` + +## Example Output + +When you run these commands, you'll get different outputs: + +### Small Talk (Comment) + +```bash +python -m chatterpy --smalltalk --comment +``` + +You might see something like this: + +``` + +Avocado toast is overrated, but I’d still eat it. + +``` + +### Small Talk (Question) + +```bash +python -m chatterpy --smalltalk --question +``` +You might get: + +``` + +I’ve been meaning to start reading/watching something new — any recommendations? + +``` + +### Pickup Line (No Name) + +```bash +python -m chatterpy --pickup --kind poetic +``` + +You could see: + +``` + +your presence feels like morning sunshine. + +``` + +### Pickup Line (With Name) + +```bash +python -m chatterpy --pickup --kind nerdy --name Susan +``` + +The output might be: + +``` + +Susan, you’re a clean solution in a messy codebase. + +``` + +### Compliment (With Name) + +```bash +python -m chatterpy --compliment --name Sydney --intensity medium +``` +This might return: + +``` + +Sydney, You always add something unique to your look. + +``` + +### Fun Facts (No parameters) + +```bash +python -m chatterpy --fact +``` + +Could get you: + +``` + +Bananas are berries, but strawberries aren’t. + +``` + +### Fun Facts (With parameters) + +```bash +python -m chatterpy --fact --category history --rarity rare +``` + +Might spit out: + +``` + +Ancient Roman concrete can 'self-heal'. + + +``` + +### Banter (No name) + +```bash +python -m chatterpy --banter --intensity medium +``` + +Will say: + +``` + +you look like something I drew with my left hand. + +``` + +### Banter (With name) + +```bash +python -m chatterpy --banter --intensity mild --name Aden +``` + +Will return: + +``` +Aden, you're like a software update: nobody asked for you. + + +``` + + + +--- + +## Features + +| Function | Description | +| ----------------------------- | -------------------------------------------------------------- | +| `fun_fact(category: str = "general", rarity: str = "common")` | Returns a random fun fact from one of four categories: `general`, `science`, `history`, or `animals`, with varying rarity| +| `smallTalk(question: bool)` | Returns either a fun question (`True`) or a random comment (`False`). | +| `pickUpLine(kind: str, name: str = "")` | Returns a pickup line of a certain type (`classic`, `poetic`, `funny`, `nerdy`). Optionally includes a name at the start. | +| `compliment(name: str, intensity: str)` | Returns a compliment of a specific intesity(`mild`, `medium`, `intense`). Includes a name at the start. | +| `banter(intensity: str, name: str = "")` | Returns a playful roast or joke depending on the chosen intensity (`mild`, `medium`, `intense`). Optionally includes a name to personalize it. | + + + +## Project Structure + +``` +3-python-package-team_mistral/ +├──src/ +│ ├───chatterpy/ +│ ├── __init__.py +│ ├── __main__.py +│ ├── funfacts.py +│ ├── smalltalk.py +│ ├── pickuplines.py +│ └── banter.py +│ └── compliments.py +│ ├─── example.py +├──tests/ +│ ├── test_funfacts.py +│ ├── test_smalltalk.py +│ ├── test_pickuplines.py +│ └── test_compliments.py +│ └── test_banter.py +├── Pipfile +├── pyproject.toml +└── README.md +``` + +## example.py + +[Link to example.py](src/example.py) + +example.py is a standalone Python script that demonstrates the functionality of the chatterpy package. It calls each of the package’s functions: fun facts, small talk, banter, pickup lines, and compliments. + +This script is separate from the CLI interface in that it can be run directly with Python, and is intended for demonstration or testing purposes, rather than as a command-line tool for user input. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..95acabd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,44 @@ +[build-system] +requires = ["setuptools>=68", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "chatterpy" +version = "0.0.1" +description = "Lighthearted conversation helpers (fun facts, etc.)" +requires-python = ">=3.9" +readme = "README.md" +authors = [ + {name = "Mahabub Alif", email = "ma7205@nyu.edu"}, + {name = "Sydney Nadeau", email = "sen5217@nyu.edu"}, + {name = "Susan Wang", email = "sw5556@nyu.edu"}, + {name = "Aden Juda", email = "asj8335@nyu.edu"}, + {name = "Serena Wang", email = "sw5695@nyu.edu"} +] +license = { file = "LICENSE" } +keywords = ["python", "package", "build", "tutorial"] +classifiers = [ + "Programming Language :: Python :: 3", + "Intended Audience :: Education", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", +] + +[project.optional-dependencies] +dev = ["pytest"] + +[project.urls] +Homepage = "https://github.com/swe-students-fall2025/3-python-package-team_mistral" +Issues = "https://github.com/swe-students-fall2025/3-python-package-team_mistral.git" + +[project.scripts] +chatterpy = "chatterpy.__main__:main" + +[tool.setuptools.package-dir] +"" = "src" + +[tool.setuptools.packages.find] +where = ["src"] + +[tool.pytest.ini_options] +pythonpath = ["src"] diff --git a/src/chatterpy/__init__.py b/src/chatterpy/__init__.py new file mode 100644 index 0000000..edb0fce --- /dev/null +++ b/src/chatterpy/__init__.py @@ -0,0 +1,8 @@ +from .funfacts import fun_fact +from .smalltalk import smallTalk +from .pickuplines import pickUpLine +from .banter import banter +from .compliments import compliment + +__all__ = ["fun_fact", "smallTalk", "pickUpLine", "banter", "compliment"] # append your function to this list +__version__ = "0.0.1" diff --git a/src/chatterpy/__main__.py b/src/chatterpy/__main__.py new file mode 100644 index 0000000..c39c2e6 --- /dev/null +++ b/src/chatterpy/__main__.py @@ -0,0 +1,74 @@ +from .funfacts import fun_fact +from .smalltalk import smallTalk +from .banter import banter +from .pickuplines import pickUpLine +from .compliments import compliment + +import argparse + +def main() -> None: + parser = argparse.ArgumentParser(prog="chatterpy") + + # funfacts + parser.add_argument("--fact", action="store_true", help="print a fun fact") + parser.add_argument("--category", default="general", + help="fun fact category (general, science, history, animals)") + parser.add_argument("--rarity", default="common", + help="fun fact rarity (common, rare)") + + # smalltalk + parser.add_argument("--smalltalk", action="store_true", + help="print a small talk line") + parser.add_argument("--question", action="store_true", + help="when used with --smalltalk, ask a question; otherwise print a comment") + parser.add_argument("--comment", action="store_true", + help="alias: if set, smalltalk will prefer comments") + + # common options + parser.add_argument("--kind", choices=["classic", "poetic", "funny", "nerdy"], + help="style/kind for pickup lines (and other funcs if applicable)") + parser.add_argument("--name", default="", help="optional name") + + # banter + parser.add_argument("--intensity", choices=["mild", "medium", "intense"], + help="tone intensity for banter/compliment") + parser.add_argument("--banter", action="store_true", help="print a playful banter/insult") + + # pickup lines + parser.add_argument("--pickup", action="store_true", help="print a pickup line") + + # compliments + parser.add_argument("--compliment", action="store_true", help="print a compliment") + + args = parser.parse_args() + + # funfacts + if args.fact: + print(fun_fact(category=args.category, rarity=args.rarity)) + + # smalltalk + if args.smalltalk: + prefer_question = True if args.question else False + if args.comment: + prefer_question = False + print(smallTalk(prefer_question)) + + # banter + if args.banter: + intensity = args.intensity if args.intensity else "medium" + name = args.name if args.name else "" + print(banter(intensity, name)) + + # pickup + if args.pickup: + kind = args.kind if args.kind else "classic" + print(pickUpLine(kind, args.name)) + + # compliment + if args.compliment: + _map = {"mild": 1, "medium": 2, "intense": 3} + inten = _map.get(args.intensity or "medium", 2) + print(compliment(name=args.name, intensity=inten)) + +if __name__ == "__main__": + main() diff --git a/src/chatterpy/banter.py b/src/chatterpy/banter.py new file mode 100644 index 0000000..99c164d --- /dev/null +++ b/src/chatterpy/banter.py @@ -0,0 +1,41 @@ +import random + +# separate banter into 3 categories, "mild", "medium," and "intense" +insults = { + "mild": [ + f"if I gave you a penny for your thoughts, I'd get change back.", + f"the closest you'll come to a brainstorm is a light drizzle.", + f"you're like a software update: nobody asked for you.", + f"your secret is safe with me, because I wasn't listening.", + f"you have the personality of a loading screen.", + ], + "medium": [ + f"I envy everyone who hasn't met you.", + f"you'll go far someday. And I hope you stay there.", + f"you look like something I drew with my left hand.", + f"if ignorance is bliss, you must be ecstatic at all times.", + f"you're the human equivalent of a participation trophy.", + f"you bring joy to every room you exit.", + + + ], + "intense": [ + f"you're like a cloud: when you disappear, it's a beautiful day.", + f"you're not stupid, you just have bad luck thinking.", + f"you're the kind of person who would get lost in their own thoughts and never be found.", + f"somewhere out there is a tree working hard to replace the oxygen you waste.", + f"you're like a Monday morning: nobody's happy to see you.", + f"you look like a 'before' picture.", + ], +} + +def banter(intensity, name=""): + """ + Returns a playful insult. + intensity is required (use mild, medium, or intense), name is optional. + """ + result = random.choice(insults[intensity]) + + if name: + return f"{name}, {result}" + return result \ No newline at end of file diff --git a/src/chatterpy/compliments.py b/src/chatterpy/compliments.py new file mode 100644 index 0000000..9ee1517 --- /dev/null +++ b/src/chatterpy/compliments.py @@ -0,0 +1,105 @@ +import random +from typing import Optional, Literal + +Intensity = Literal[1, 2, 3] +Style = Literal["classic", "geeky", "poetic"] +Category = Literal["personality", "appearance", "accomplishment", "specific"] + +def compliment( + name: str = "", + intensity: Intensity = 1, + style: Style = "classic", + category: Category = "personality", + detail: Optional[str] = None, +) -> str: + intensity = 1 if intensity < 1 else 3 if intensity > 3 else intensity + + base = { + "personality": { + 1: [ + "You're such a thoughtful person.", + "You have a gift for making others feel valued.", + "I appreciate your honesty.", + ], + 2: [ + "Your confidence is inspiring.", + "Your kindness is contagious.", + "You have an amazing sense of humor.", + ], + 3: [ + "Your presence lifts everyone around you.", + "Your integrity and empathy set the standard.", + "Your strength under pressure is remarkable.", + ], + }, + "appearance": { + 1: [ + "I love your sense of style.", + "That color looks great on you.", + "You look great today.", + ], + 2: [ + "Your outfit is on point.", + "You always add something unique to your look.", + "Your smile lights up the room.", + ], + 3: [ + "Your look today is stunning.", + "Your style is effortlessly impressive.", + "You have a standout, polished presence.", + ], + }, + "accomplishment": { + 1: [ + "I admire your creativity.", + "You're a considerate, dependable team player.", + "You have a real way with words.", + ], + 2: [ + "You're an exceptional problem-solver.", + "Your ideas are fresh and insightful.", + "You structure complex tasks brilliantly.", + ], + 3: [ + "Your work sets a new bar for quality.", + "Your leadership on tough tasks is outstanding.", + "You consistently turn hard problems into clear wins.", + ], + }, + "specific": { + 1: [ + "I was really impressed by {detail}.", + "Your thoughtful approach to {detail} stood out.", + ], + 2: [ + "The way you handled {detail} showed real skill.", + "{detail} was a smart, well-judged choice.", + ], + 3: [ + "{detail} was exceptional—truly impressive.", + "Your execution on {detail} was outstanding.", + ], + }, + } + + pool = base.get(category, base["personality"])[intensity] + sentence = random.choice(pool) + + if category == "specific": + sentence = sentence.replace("{detail}", detail or "that") + + style_tail = { + "classic": "", + "geeky": " It's elegantly optimized.", + "poetic": " Like sunlight through calm water.", + }[style] + + if name: + sentence = f"{name}, {sentence}" + + banned = ["for someone like you", "than you look", "actually pretty good", "not bad", "surprisingly good"] + if any(b in sentence.lower() for b in banned): + sentence = f"{name+', ' if name else ''}You're doing great." + + return (sentence + style_tail).strip() +#TODO diff --git a/src/chatterpy/funfacts.py b/src/chatterpy/funfacts.py new file mode 100644 index 0000000..e8f5cab --- /dev/null +++ b/src/chatterpy/funfacts.py @@ -0,0 +1,55 @@ +import random + +#data +FACTS = { + "general": { + "common": [ + "Bananas are berries, but strawberries aren’t.", + "Octopuses have three hearts.", + ], + "rare": [ + "Sharks existed before trees.", + "Honey never spoils—it can last for millennia.", + ], + }, + "science": { + "common": [ + "A day on Venus is longer than a year on Venus.", + "Humans share about 60% of their DNA with bananas.", + ], + "rare": [ + "Water can boil and freeze at the same time (triple point).", + "There are more stars in the universe than grains of sand on Earth.", + ], + }, + "history": { + "common": [ + "Oxford University predates the Aztec Empire.", + "Cleopatra lived closer to us than to the building of the pyramids.", + ], + "rare": [ + "Ancient Roman concrete can 'self-heal'.", + "The first computer bug was a real moth (1947).", + ], + }, + "animals": { + "common": [ + "A group of flamingos is called a flamboyance.", + "Cows can have best friends.", + ], + "rare": [ + "Axolotls can regenerate parts of their brain.", + "Some jellyfish can revert to a juvenile state.", + ], + }, +} + + +def fun_fact(category: str = "general", rarity: str = "common") -> str: + """ + Return one fun fact. + Falls back to general and common if inputs are unknown. + """ + cat = FACTS.get(category) or FACTS["general"] + pool = cat.get(rarity) or cat["common"] + return random.choice(pool) diff --git a/src/chatterpy/pickuplines.py b/src/chatterpy/pickuplines.py new file mode 100644 index 0000000..10b901f --- /dev/null +++ b/src/chatterpy/pickuplines.py @@ -0,0 +1,42 @@ +import random + +PICKUPLINES = { + "classic": [ + "you have a great smile.", + "you make the room feel brighter.", + "your kindness stands out.", + "you have awesome energy.", + ], + "poetic": [ + "your presence feels like morning sunshine.", + "your laugh sounds like a good song.", + "you carry a little bit of starlight with you.", + "you’re a calm breeze on a warm day.", + ], + "funny": [ + "you’re the human version of the ‘skip intro’ button, instantly great.", + "your vibe is like perfect wifi, I feel a connection.", + "you’re meme-worthy in the best way.", + "you’re plot-armor for bad moods.", + ], + "nerdy": [ + "you’re a clean solution in a messy codebase.", + "your curiosity has amazing test coverage.", + "you’re big-O of awesome: constant impact.", + "you’re a well-documented feature of the universe.", + ], +} + +def pickUpLine(kind, name=""): + """ + Returns a compliment + kind is required, name is optional + """ + if kind not in PICKUPLINES: + raise ValueError("unknown kind (use classic, poetic, funny, nerdy)") + + line = random.choice(PICKUPLINES[kind]) + + if name: + return f"{name}, {line}" + return line diff --git a/src/chatterpy/smalltalk.py b/src/chatterpy/smalltalk.py new file mode 100644 index 0000000..3e07ef6 --- /dev/null +++ b/src/chatterpy/smalltalk.py @@ -0,0 +1,47 @@ +# Small Talk function +# Implement function that returns small talk. + +import random + +questions = [ + "How's your day going?", + "What's your favorite color?", + "What's your favorite programming language?", + "I’m running purely on caffeine today — you?", + "Do you usually listen to music when you work?", + "What’s your go-to comfort show or movie?", + "I’ve been meaning to start reading/watching something new — any recommendations?", + "What do you like to do outside of school/work?", + "Do you have any hobbies you’ve picked up recently?", + "What kind of music are you into?", + "Are you more of an introvert or extrovert?", + "If you could travel anywhere right now, where would you go?", + "What’s a random skill you wish you had?", + "What’s your comfort food?", + "Do you like podcasts or audiobooks?", + "Are you a cat person, dog person, or both?", + "Anything fun or random happen to you today?" +] + +comments = [ + "The weather is nice today.", + "I’m convinced every day this week has been Tuesday.", + "I need a nap.", + "It’s one of those days where coffee feels more like a necessity than a choice.", + "My brain clocked out hours ago.", + "People who can wake up early and be nice about it scare me a little.", + "Socks with sandals are just misunderstood geniuses.", + "Avocado toast is overrated, but I’d still eat it.", + "Pineapple on pizza is disgusting.", + "I hate vegetables.", + "Movies are boring.", + "'The Office' isn't funny." +] + + +def smallTalk(question): + if question: + return random.choice(questions) + return random.choice(comments) + + diff --git a/src/example.py b/src/example.py new file mode 100644 index 0000000..c63710d --- /dev/null +++ b/src/example.py @@ -0,0 +1,60 @@ +from chatterpy.funfacts import fun_fact +from chatterpy.smalltalk import smallTalk +from chatterpy.banter import banter +from chatterpy.pickuplines import pickUpLine +from chatterpy.compliments import compliment + +def demo_chatterpy(): + keep_going = True + _map = {"mild": 1, "medium": 2, "intense": 3} + + while(keep_going): + choice = input("Enter a choice for your conversation:\n" + "\t1. Banter\n" + "\t2. Compliment\n" + "\t3. Fun fact\n" + "\t4. Pick up line\n" + "\t5. Small talk\n") + + if choice == "1": + intensity = input("Enter an intensity (mild, medium, intense): ") + name = input("Enter a name: ") + print(banter(intensity, name)) + + elif choice == "2": + intense = input("Enter an intensity (mild, medium, intense): ").strip().lower() + intensityNum = _map.get(intense or "medium", 2) + name = input("Enter a name: ") + print(compliment(name, intensityNum)) + + elif choice == "3": + category = input("Enter a category (general, science, history, animals): ") + rarity = input("Enter a rarity (common, rare): ") + print(fun_fact(category, rarity)) + + elif choice == "4": + kind = input("Enter what kind of pickup line (classic, poetic, funny, nerdy): ") + name = input("Enter a name: ") + print(pickUpLine(kind, name)) + + elif choice == "5": + questionComment = input("Enter question or comment: ").strip().lower() + if questionComment == "question": + print(smallTalk(True)) + else: + print(smallTalk(False)) + + else: + print("Invalid choice! Please enter a number 1 - 5.") + + again = input("Do you want to continue? Y/N: ").strip().lower() + if again != "y": + keep_going = False + print("Goodbye!") + +def main(): + demo_chatterpy() + + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/tests/test_banter.py b/tests/test_banter.py new file mode 100644 index 0000000..66d4151 --- /dev/null +++ b/tests/test_banter.py @@ -0,0 +1,48 @@ +import pytest +from chatterpy.banter import banter + + +class TestBanter: + + # Intensity level tests + def test_mild_intensity_works(self): + mild_keywords = ["penny", "drizzle", "software", "secret", "loading"] + found = False + for _ in range(15): + if any(word in banter("mild").lower() for word in mild_keywords): + found = True + break + assert found, "Expected mild-specific content" + + def test_medium_intensity_works(self): + """Test medium intensity returns appropriate content.""" + medium_keywords = ["envy", "far someday", "left hand", "participation", "exit"] + found = False + for _ in range(15): + if any(word in banter("medium").lower() for word in medium_keywords): + found = True + break + assert found, "Expected medium-specific content" + + def test_intense_intensity_works(self): + """Test intense intensity returns corresponding content.""" + intense_keywords = ["cloud", "bad luck", "lost", "tree", "monday", "before picture"] + found = False + for _ in range(15): + if any(word in banter("intense").lower() for word in intense_keywords): + found = True + break + assert found, "Expected intense-specific content" + + # Error handling tests + def test_invalid_intensity_raises_error(self): + with pytest.raises(KeyError): + banter("extreme") + + def test_empty_intensity_raises_error(self): + with pytest.raises(KeyError): + banter("") + + def test_wrong_type_intensity_raises_error(self): + with pytest.raises(KeyError): + banter(123) \ No newline at end of file diff --git a/tests/test_compliments.py b/tests/test_compliments.py new file mode 100644 index 0000000..d8e2a35 --- /dev/null +++ b/tests/test_compliments.py @@ -0,0 +1,88 @@ +import random +import pytest +from chatterpy.compliments import compliment + +""" +Unit tests for compliment(). +""" + +@pytest.fixture(autouse=True) +def _seed_each_test(): + # Ensure repeatable outputs for tests that rely on random.choice + random.seed(0) + + +def test_returns_nonempty_string(): + result = compliment() + assert isinstance(result, str) + assert result.strip() != "" + + +def test_name_prefix_present_when_provided(): + s = compliment("Serena", intensity=2) + assert s.startswith("Serena, ") + + +def test_intensity_is_clamped_to_1_3_bounds(): + low = compliment(intensity=0) # below lower bound -> clamp to 1 + high = compliment(intensity=99) # above upper bound -> clamp to 3 + assert isinstance(low, str) and isinstance(high, str) + assert low.strip() != "" and high.strip() != "" + + +@pytest.mark.parametrize( + "style, tail_check", + [ + ("classic", lambda s: not s.endswith("optimized.") and "calm water." not in s), + ("geeky", lambda s: s.endswith("optimized.")), + ("poetic", lambda s: s.endswith("calm water.")), + ], +) +def test_style_tails(style, tail_check): + s = compliment(style=style) + assert tail_check(s) + + +@pytest.mark.parametrize("category", ["personality", "appearance", "accomplishment"]) +def test_all_standard_categories_return_strings(category): + s = compliment(category=category, intensity=2) + assert isinstance(s, str) + assert s.strip() != "" + + +def test_specific_category_without_detail_uses_placeholder(): + s = compliment(category="specific", intensity=1) + assert "that" in s.lower() + + +def test_specific_category_with_detail_is_injected(): + s = compliment(category="specific", detail="your presentation", intensity=2) + assert "your presentation" in s + + +def test_invalid_category_falls_back_gracefully(): + s = compliment(category="not-a-real-category") + assert isinstance(s, str) and s.strip() != "" + + +def test_backhanded_fragments_are_filtered_out(): + banned = [ + "for someone like you", + "than you look", + "actually pretty good", + "not bad", + "surprisingly good", + ] + s = compliment() + assert not any(b in s.lower() for b in banned) + + +def test_accepts_none_name_without_crashing(): + s = compliment(name=None) + assert isinstance(s, str) and s.strip() != "" + + +def test_output_is_single_line_no_newlines(): + s = compliment() + assert "\n" not in s and "\r" not in s +#TODO \ No newline at end of file diff --git a/tests/test_funfacts.py b/tests/test_funfacts.py new file mode 100644 index 0000000..b1a0c98 --- /dev/null +++ b/tests/test_funfacts.py @@ -0,0 +1,13 @@ +from chatterpy.funfacts import fun_fact, FACTS + +def test_returns_string_nonempty(): + s = fun_fact() + assert isinstance(s, str) and s.strip() + +def test_fallback_on_unknown_inputs(): + s = fun_fact(category="???", rarity="???") + assert isinstance(s, str) and s.strip() + +def test_member_of_requested_pool(): + s = fun_fact("science", "rare") + assert s in FACTS["science"]["rare"] diff --git a/tests/test_pickuplines.py b/tests/test_pickuplines.py new file mode 100644 index 0000000..758a9ec --- /dev/null +++ b/tests/test_pickuplines.py @@ -0,0 +1,24 @@ +from chatterpy.pickuplines import pickUpLine, PICKUPLINES + +def test_pickUpLine_returns_string(): + actual_no_name = pickUpLine("classic") + actual_with_name = pickUpLine("poetic", "Aden") + assert isinstance(actual_no_name, str), f"Expected a string, got {actual_no_name}" + assert isinstance(actual_with_name, str), f"Expected a string, got {actual_with_name}" + +def test_member_of_requested_pool_no_name(): + actual = pickUpLine("funny") + assert actual in PICKUPLINES["funny"], f"Expected a funny pick up line, got {actual}" + +def test_member_of_requested_pool_with_name(): + actual = pickUpLine("nerdy", "Sam") + base = actual.replace("Sam, ", "") + assert base in PICKUPLINES["nerdy"], f"Expected a nerdy pick up line, got {actual}" + +def test_name_prefix_when_provided(): + actual = pickUpLine("classic", "Taylor") + assert actual.startswith("Taylor, "), f"Expected 'Taylor, (pick up line)', got {actual}" + +def test_randomness_over_multiple_calls(): + chosen = set(pickUpLine("poetic") for _ in range(50)) + assert len(chosen) > 1 diff --git a/tests/test_smalltalk.py b/tests/test_smalltalk.py new file mode 100644 index 0000000..6519a6d --- /dev/null +++ b/tests/test_smalltalk.py @@ -0,0 +1,29 @@ +# Unit tests for smallTalk function in ChatterPy module + +from chatterpy.smalltalk import smallTalk, questions, comments + +# Correct return type test +def test_smallTalk_returns_string(): + actualQuestion = smallTalk(True) + actualComment = smallTalk(False) + + assert isinstance(actualQuestion, str), f"Expected smallTalk(True) to return a string. It instead returned {actualQuestion}" + assert isinstance(actualComment, str), f"Expected smallTalk(False) to return a string. It instead returned {actualComment}" + +# Correct return (question or comment) based on input tests +def test_questions(): + actual = smallTalk(True) + assert actual in questions, f"Expected a question from the questions list, got {actual}" + +def test_comments(): + actual = smallTalk(False) + assert actual in comments, f"Expected a question from the questions list, got {actual}" + +# Sufficient coverage of questions/comments tests +def test_smallTalk_randomness_questions(): + chosen = set(smallTalk(True) for i in range(50)) + assert len(chosen) > 1 + +def test_smallTalk_randomness_comments(): + chosen = set(smallTalk(False) for i in range(50)) + assert len(chosen) > 1 \ No newline at end of file