Changelog

Current version

Documentation

• Add User to the documentation

• Add a features list (e0155add9888f3efc6b2113701f512265c54b4ac)

• Add docstrings to User (9e7c1e6cb545fafef724eeebb3fc8589aa6eca7c)

Fixes

• Create _static/examples directory (13c734b3fef563821e39993100c06f32e49f1aef)

• Do not raise UnboundLocalError anymore (ce46b4f4a094cede204f01275fa9973b4a90e0cc)

• Keep backwards compatibility for sphinx (f6a5e9c3163c619abe5dc199545879bd4d0ddccf)

• Set master_doc to index (0042b2e78e1e9f4b299fb81eb8eb167e4b8287d4)

New features

• Add User (17c92f73dd7409729acad316bd8b819ef0cb5e95)

v0.1a2 - 2020-06-19

Fixes

• Use lru_cache in a compatible way with Python 3.6 (5b82e39b5fa1ce8aa7ffbe4d5b7c97d74bd878fb)

Other changes

• Go from pre-alpha to alpha (5741b021e100054fd799609a09e20d819f5de43e)

v0.1a1 - 2020-06-19

Documentation

• Add contributing guidelines (5474eb251a807e76ed00b05fb3d49024ca654525)

v0.1a1.dev7 - 2020-06-19

Documentation

• Add a flowchart for cafe_bot.py (3664a0ad9f51c434c00fd6e4cf2d603e6953b530)

• Add a flowchart for calendar_bot.py (f7b41b594d62a2874a280bb93b4b1ea419ea35d1)

• Add a flowchart for hitchhiker_bot.py (3f7057244f3e1c868e0e7b00f04e39d481468a6d)

• Add a flowchart for sample_bot.py (a698a4f1c7b85640011f861b9f2ae6ffa5dbd001)

• Add a license notice to the documentation (resolve #7) (54bf64e414f5d8315d687938e56fb01548e2c67f)

• Add a reference to the author’s GPG public key (0054e2af66d239d2d60aa8c2e26fe7f32747dfaa)

• Add a simple glossary (0000e5ecc76f27f66833a28ef67836b5a338a353)

• Add a simple quickstart menu (3b4e5c7581ec4457bc8427068524954ec4920418)

• Add a tip for opening a feature request (909dfff2923e8b551d4500f48223659cd1d97ec4)

• Add docstrings to command_filter and deep_link_filter (b61629afa1d85f80fea4ec5030ab756d47714fea)

• Add flowchart guidelines (5f8b39464dd2558ef8792ab2f554f25e9d65d8a0)

• Add flowcharts (c170d6aa8630e2f0575e79e0b10dcb5bab84a119)

• Finish writing the tutorial (3ed75930ab0a57d84dad25880bdde86e1e7d66f4)

• Flowcharts are now transparent (0c32a87eb5610b4b4304ab43eea4b706da69f224)

• Include examples in the toctree (737c1223e9ef4c95d9cac78c43e8820f7210069f)

• Make the glossary terms highlight within the documentation (5bb5d735a1db8081cacb41768ed1ca205ce79514)

• Update docstrings for pass_parameterized_handler (aa5a7a7b884db15a0c1c83b6d43bbf078fa58d4d)

Fixes

• Make all the flowcharts follow the guidelines (5e308d275e81617b2ce2cb89181e43f2d086db94)

• Make the documentation consistent by deleting wrong content (48c8efaf0efe95e86cc25decf0670920441781fe)

• Preserve order while adding a new child to a node (8a0980c41c18b67d98830d00db10b77c59a85c07)

New features

• Add cafe_bot.py as an example for multiple commands (bacce5d540c3e4f36070ce4b554089381aa151fc)

• Do not store parameters related to null-pointer buttons (2f43274ba12086b19540021f1197aa4de2770436)

Other changes

• Delete references to LGPLv3 (a7334b1a32b369239db8f1ec997cf2467d3c9420)

• Exclude generated reStructuredText files (4767232558cd0dc9788796d908294a783762e792)

• Update version to 0.1a1.dev7 (f9190b87c11822203511b8784e5f4248313a59e4)

Testing changes

• Add multiple tests for DeepLinkMenu (b92f22086d0f958a895e487b6de3b8f199de537f)

• Add multiple tests for DictDatabase (4682b54f227b5cbd4f9ce7d968188a9e8021781d)

• Add multiple tests for LinkMenu (929622547de7795afb2619d4ea4a19b1891434c7)

• Add multiple tests for Menu (d3cf32677bfd36f1817586a655bab8958e8f21f6)

• Add multiple tests for Node and transform (7d9fa0a1a874316993a2ee8c50f5deeb22931abf)

‼️ Breaking changes

• Add LinkMenu (2776ae7fd71649cb5fc2756665d931755379c678)

• Add pyrubrum.menus.styles and the style argument (fbcfe0f63c4ecbab228f28942177d17d59d3dcb9)

• Consider valid only the queries sent from the same user (6f8d9310c7bf52fc3f9f888061f84d7394453b17)

• Implement md5 encryption for parameterized handlers (2f790256744a41b21956ae9acc867f1eb33a1496)

• Support deep-linking (c70cd3010b739d8b0f3bd013dfdb70faedb4ab8e)

v0.1a1.dev6 - 2020-06-14

Documentation

• Add Sphinx integration and stop usingdataclasses (63b3ad54ab218ec41c72cdf65086ff1e07a64200)

• Add docstrings to Types (9482313b2e8adae5e9271bd7f451413065b94a4a)

• Add the Types class to the documentation (880c52c04e1d3feab948d23fb8651393c9072d37)

• Automatically copy files from the main directory (6474feee10ca1dcf1ebc58a49770063f5c931ab9)

• Update assets (9d6ca77f936e12b1d851c34ae1ddc39376107063)

Fixes

• Delete Menu.preliminary in favour of the eponymous attribute (a4023312360a6295f4748dd08349dde99b3805bd)

• Edit documentation for Menu.default (003137fdda1de337e6aa7fb0e81c7fcdfc4337d9)

• Upload correct changelog links to PyPi (b9b4cdeb01d449f4c18322ce6c8a5f8f0ab47051)

New features

• Add PageStyle for customizing PageMenu layouts (46a14edb7f57d0d5b23f11091c806b5b8e2ada58)

• Do not pass parameters to content functions if not supported (dad5907521d635701cbea12ac736b4f0362e41e6)

• Import all the public functions (c0a7deb30fbe75d6b8c37f71dcaaa49ba8b3ab8f)

• Import database errors by default (eb6bb8b5320676e1f474097e3738d54ddddb31e7)

• Support providing multiple preliminary functions (3938e308c2176bd280454cdab1875abbae470a28)

• Use None if parameterization is not supported (resolve #5) (fd3af3fda4747a6ab4bf5f978bb15e4390aed5d1)

Other changes

• Do not restrict callbacks to Message and CallbackQuery (ec6bab8600efa7015964a79839046c46a91ebe29)

• Rename all variables named treeto handler (b9acc90cc899cf4c08315a7123017cf8e7169106)

• Update version to 0.1a1.dev6 (477293742e2cc5b238d3bea9503045f2f41f8514)

‼️ Breaking changes

• Add support for having multiple text commands (resolve #4) (80bfb7d0360091f0e4126b7c4709823e82f1191e)

• Create specific directories for module entities (25593e6d40fa34dbc47528ff3fa6fdc30c0a41b9)

• Move recursive_add and transformto pyrubrum.tree.node (74fa78d207cac97c7f01fcdc562c75b0bc81db7c)

• Move types to a brand new directory (7d6b33b3af33a7a69999966aa4caf6728ade7598)

• Preliminary functions are now passed as arguments (resolve #6) (45687a4a0a2b407b8085ec78d008536bd598897a)

• Rename on_callback_node to recursive_add (461d34e9fb293347ca0b38aa41a18511c25b857c)

• BaseDatabase.get always returns a string (resolve #2) (b1d0dac010d2d0cd46a4bcc41d2f07c2099d6ac9)

v0.1a1.dev5 - 2020-06-12

Documentation

• Add callback_query_id as a special key for parameters (7222fcc6eb3c2a037c2b71109c9163028ef4eea4)

• Add a code of conduct (95694f93986ede7545a782e6b34b8ec7ca2a2c93)

• Add a notice about the keys starting with page_ (18bdd9c336fb41a89984e97ee39f81b33c5809a2)

• Add a security policy (ba507a8b2a6a386d7ad2d561d9b805d341e8b284)

• Add a statement about the return value of Node.__hash__() (5a9a257ef122bd47f0a010dc5e1ebcb5e1cb1b90)

• Add disclaimer notice (a7a6060a7243a1ed7857b2b78649d573cbe7feab)

• Add docstrings to BaseDatabase (d3fd9a769e62196f01d3764b87896761bbaf77d6)

• Add docstrings to BaseHandler (455a0a94977c1652b445b623df561f9606a0615e)

• Add docstrings to BaseMenu (3a7ad4e3b23bfb85a9faa8c3c056e76abb87b771)

• Add docstrings to Button (73a0848e8bd7159599d2023d86249f192fde65b4)

• Add docstrings to DictDatabase (7776cdc6f50e5fdda3774dd4e59a0c7bc81b41d2)

• Add docstrings to Element (9dc20b8ad7f93b170da48d6287337f3ec5fa0fe1)

• Add docstrings to Handler and its relative functions (fc1c7e10085b5b678298dccc87c9f83e1ad97dfb)

• Add docstrings to Keyboard (c3b4f5f879eec2d953ed47be26e03241a7b0cfe7)

• Add docstrings to Menu (15c11e4f737c0c63bad29d6c3c758d2b775c9ea4)

• Add docstrings to Node (caf69bb8f7c6542bb731b7df6bf0f7ab7b3d4bd9)

• Add docstrings to PageMenu (1e90e66bddb6da14a75df2b0c1dd141d1688484e)

• Add docstrings to ParameterizedBaseHandler (579ad0916dc138c0d3117ae6f90e92a1cf11c1ea)

• Add docstrings to ParameterizedHandler (9b3e293e2e1a63fa79c557ca496a22facf36c76b)

• Add docstrings to RedisDatabase (784b8f112d561b9a346b7f986710df2b1455e691)

• Add docstrings to all the database exceptions (0e561554d9d37ef755202cb7ef2905aadbd84700)

• Add issue templates (64c006258e373a97d0a9f83318af02c4310b585b)

• Add reference to the features list (72a01dafbf42b0bb1140a62371959702040be230)

• Add the official pronunciation for Pyrubrum (b6d1fe8e01f79007338cd4a6dfe409c406c12cba)

• Create the changelog of the current release separately (318172a986e666ac4abf6f7a4480922cb135e734)

• Delete duplicate issue templates (10cba65c31a5c3556b39cc328d097b62dfbd5e1b)

• Extend the definition of ParameterizedBaseHandler (08b258866b4182afae6fc7e439a74b5e30d86f4e)

• Make relative clauses more formal (6b0d84effd65838668b3ba070a677d03ce016581)

• Stop using typing.NewType and use aliases instead (600191f337178baf21ea5ffe3e9caaa19dbf22e0)

• Update the disclaimer notices (b5039179f28a24ecf967b66200c9440cb6b6c6ec)

Fixes

• Add space before reference links (dfbf7a55f3a7de666703b1dced404d1ce7b0ee7a)

• Capitalize only the first character of a commit message (2996f7c91723902b4e998fb94b6d31c60685d386)

• Do no more raise TypeError while formatting commits (56f1e533c12bdf75e63714d125319bb72da7d916)

• Edit the documentation for on_callback and on_message (3af2b75fb062727b748f9319cea5a4632dc2cb56)

• Fix commit-message for Dependabot (a13cfeae848d83339a902373ddcb0287fc306d87)

• Hide the sha-1 hash of the current commit (ab6478e610ef828744d5c6e54a1d54fff92372e8)

• Make Element docstrings consistent with Button ones (9a035a35439077a9f12371bc96e6508020f3ecd6)

• Make databases consistent with the documentation (d5debbfa52eb16e012ad8e022a5b3d8a06051a59)

• Menus are now collected using sets instead of unhashable lists (46755e471bb94efd963af3bd7b9da95de39bdbed)

• Use deep copying instead of just making a shallow copy (2c98a3c281db85cec19eb0e7027a0438827aa236)

New features

• Add MANIFEST.in for managing files included in the distribution (1f160d30f2288bf484bae622ac56bc0a119c6cfa)

• Automatically detect the commit URL for changelog (a5be95bf1f782bff658552ee4b54552f611409c4)

• Do not set an expire if False is provided (3378a6177ff896417025447a8a35df094eb13799)

• Import the base classes as well (1d11b934967258164d0f4fc57e01e4116d19b72c)

• Include the release dates inside changelog (d4397f396c64eeec6549cd90c64cef6359017dd5)

• Integrate Dependabot (2bb0a43b0f7f8266c7d0544209194c2b26b878a4)

• Integrate memoization into Handler (9e7297f12146183352aaadce127adb855d3a115b)

• Integrate memoization into Node (d80faabfaa9daceef632f7ce55bbff49a56d2986)

• Make parameters optional for on_callback and on_message (562f323da2d19913405a5efcfe531e37fa54baf5)

• Support datetime.timedelta as an expire object (6b3453f5a888fe758f868592c17a88ed1678936f)

• Use the set of children without conversion to list (resolve #3) (e81143b154b415531ee82dfe85613e8fd01b1644)

Other changes

• Add __copyright__ (af247708db3ddf033d1c4addac31d1ef3ce0590a)

Testing changes

• Version is now tested to be compliant with PEP 440 (5f5928bd49e7457d331229440c008665d91647ea)

‼️ Breaking changes

• Use abstractmethod for the methods of base classes (d5d2edd51cc2137287568a353dd3dc821c29a16c)

v0.1a1.dev4 - 2020-06-09

Documentation

• Add a reference to hitchhiker_bot.py (b14423f7586f193a0024d016eb4c98b1e5165ba8)

• Add reference to the changelog (862839c9cb33c80a512485148c2f132e59ce659b)

• Add the official logo (d9da10bada6335c1d50c6be9e663259313c5d333)

Fixes

• Correct a typo regarding hitchhiker_bot.py (a43bf4bc97e024237a447443be402b5f990384b7)

• Do not use git hooks while generating the changelog (ef705c3451f8c5b028153664598a4734f4f2a16a)

• Generate changelog using the previous commit (7eecd3ad26d0586077f4a65b443f24b490eda207)

• Render sha-1 hashes as links (415e34c8f467d2f21db47fbfcc2875a3a5a0a8d1)

• Render sha-1 hashes in a proper way (0dd5b36883b314c640813fb84635d34937a5d274)

New features

• Add a changelog generator script (e2663e2e23ce84415e536cd305661b221431081f)

Other changes

• Update version to 0.1a1.dev4 (29c4f20d4e91ac89c56d1e491fc4be0fc8b858b0)

Refactoring

• Use pre-commit as a local testing system (8898c9a6409b5e7a37c29024b293ec7799379dc6)

Style changes

• Reorder classifiers (2bd2de48916a8ba2c794ad0dac6b9e2d7b3919b8)

v0.1a1.dev3 - 2020-06-09

Fixes

• Media now support inline keyboards (d268afedb61b0ebb54d30608e39a599c47a64c6c)

New features

• Add an example for sending media (5bc4aae9b3e35d8e3940a2a1961a60e3dd307879)

• InputMediais now allowed to be sent as message (5c054ea9f7eaaabc5af0f0625c5475681d1e1fce)

Other changes

• Update version to 0.1a1.dev3 (0459153cd238bf3d73318e5908c418bf35523fbe)

v0.1a1.dev2 - 2020-06-09

Build changes

• Ignore ModuleNotFound error (b80d94254de8445345bcdcec82f41a3128cf6887)

Documentation

• Add branding information (b64560b5bdaceaf7ea89963c1aa54161bc4ee0eb)

• Add versioning specification & thanks (e9832c2adcaf2854af8e64af9512edcc6dce7b89)

• Refer only to Telegram bots page (8ec71abbee5425a880fa0a27ba543370ceaaa412)

Other changes

• Update version to 0.1a1.dev2 (24e68eb18a2691f88938bdf30d1caa90216cfb07)

v0.1a1.dev1 - 2020-06-09

Build changes

• Redis is now not installed by default (bedaa03da1635c9d52765dc6de67d77758b556e0)

Other changes

• Update version to 0.1a1.dev1 (068ae25d49632d11082ddc9c2f539ecca5f512ec)

v0.1a1.dev0 - 2020-06-09

‼️ Breaking changes

• Rename handlers & menus (22eec554399fe3f250b414f79c45f5af9b9dd2b0)

v0.1a0 - 2020-06-09

New features

• A callable object is now supported (1ce23a93f26813ba686e08ec66d1eeaae25acfbf)

• Add Action (b41f03ab0d47b628ee42dfeeacc0b58684fc37b6)

• Add BaseDatabase & DictDatabase (ce59115815025a18f41388b1735bbca789675aef)

• Add CalendarBot (f640efb16aa7c59cc39bfedc62e532292f347cdb)

• Add ParameterizedTreeHandler and ParameterizedHandler (823a0436e3b6c8e75a0710f67b420d4810fff808)

• Add SampleBot & README.md (f4838f8f80eac5f41ef6f234160c86524b339402)

• Add TreeHandler and TreeMenu (bfec481b41e791809d82ca9e75620f94c9ace45c)

• Add a blank line to README.md (6338308089c46b08dc301b646e28579e0d63af92)

• Add subtitle (82dd5f08f7a0c7eeb10d11e7c576630fd804b58c)

• Add support for paging (87af4882d5b89a293332a3ff31d614d9dfab40ac)

• Add unique_id (334d5a0576d9ecf383115399b83a7aab7b5f116e)

• Add versioning, change name to ‘pyrubrum’ & update setup.py (5174a672e6322eeccc3744a3b3e49c5faaa7d707)

• Delete Button.set_name (4624a2cc66b5b236918130a3a6ec16e685ea63da)

• Delete blank lines from README.md (5609d2383a49dfc36c2d8a547f5f3e03e7fea153)

• Fix classifiers (051564e3460d44fb17d95718fa86b94044512c1e)

• Implement parameters using JSON (0b848266fd45f99dad3910313b8ec61943502b6b)

• Implement the propagation of parameters (0a128c99358d918d3f379449ee352b1d4193354a)

• Iterables are now supported as dictionary values (4052f630ad7ef30def4586db952b02b132277d8d)

• Rename Action to Element & id to element_id (b187e00933139b5e98dff0922f080ec80f387de4)

• Stop using keyword-arguments, use a dictionary instead (a3b4ccb70bdacb2e50d6859b8095dd8996e589e8)

• Stop using regex (2cd8e969c90b3dd425164ee1a107fb12148f4079)

• Support Redis (8756a59b3214f676aad4ead76ec8f071c4dc4418)

• Update README.md (fix markdown issues) (772f745351b1f494cfe57cb814315c6533b61f98)